From 01929c5476d81e19c8fcbe9b256f6592c68531bd Mon Sep 17 00:00:00 2001 From: Sima Kinsart Date: Sun, 30 Oct 2022 14:39:45 +0600 Subject: [PATCH] Update the feature set with `rocksdb-storage` Former-commit-id: e2f6fde7432bc943d9cf78a03b247025b55668c3 --- src/features.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/src/features.md b/src/features.md index 1545af78..a0456377 100644 --- a/src/features.md +++ b/src/features.md @@ -1,27 +1,28 @@ ## Cargo features -| Feature | Description | -|----------------------|--------------------------------------------------------------------------------------------| -| `webhooks` | Enables general webhook utilities (almost useless on its own) | -| `webhooks-axum` | Enables webhook implementation based on axum framework | -| `macros` | Re-exports macros from [`teloxide-macros`]. | +| Feature | Description | +|----------------------|-------------| +| `webhooks` | Enables general webhook utilities (almost useless on its own). | +| `webhooks-axum` | Enables webhook implementation based on axum framework. | +| `macros` | Re-exports macros from [`teloxide-macros`]. | | `ctrlc_handler` | Enables the [`DispatcherBuilder::enable_ctrlc_handler`] function (**enabled by default**). | -| `auto-send` | Enables the [`AutoSend`](adaptors::AutoSend) bot adaptor (**enabled by default; DEPRECATED**). | -| `throttle` | Enables the [`Throttle`](adaptors::Throttle) bot adaptor. | -| `cache-me` | Enables the [`CacheMe`](adaptors::CacheMe) bot adaptor. | -| `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | -| `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | -| `full` | Enables all the features except `nightly`. | -| `nightly` | Enables nightly-only features (see the [`teloxide-core` features]). | -| `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | -| `rustls` | Enables the [`rustls`] TLS implementation. | -| `redis-storage` | Enables the [Redis] storage support for dialogues. | -| `sqlite-storage` | Enables the [Sqlite] storage support for dialogues. | -| `cbor-serializer` | Enables the [CBOR] serializer for dialogues. | -| `bincode-serializer` | Enables the [Bincode] serializer for dialogues. | - +| `auto-send` | Enables the [`AutoSend`](adaptors::AutoSend) bot adaptor (**enabled by default; DEPRECATED**). | +| `throttle` | Enables the [`Throttle`](adaptors::Throttle) bot adaptor. | +| `cache-me` | Enables the [`CacheMe`](adaptors::CacheMe) bot adaptor. | +| `trace-adaptor` | Enables the [`Trace`](adaptors::Trace) bot adaptor. | +| `erased` | Enables the [`ErasedRequester`](adaptors::ErasedRequester) bot adaptor. | +| `full` | Enables all the features except `nightly`. | +| `nightly` | Enables nightly-only features (see the [`teloxide-core` features]). | +| `native-tls` | Enables the [`native-tls`] TLS implementation (**enabled by default**). | +| `rustls` | Enables the [`rustls`] TLS implementation. | +| `redis-storage` | Enables the [Redis] storage support for dialogues. | +| `rocksdb-storage` | Enables the [RocksDB] storage support for dialogues. | +| `sqlite-storage` | Enables the [Sqlite] storage support for dialogues. | +| `cbor-serializer` | Enables the [CBOR] serializer for dialogues. | +| `bincode-serializer` | Enables the [Bincode] serializer for dialogues. | [Redis]: https://redis.io/ +[RocksDB]: https://rocksdb.org/ [Sqlite]: https://www.sqlite.org/ [CBOR]: https://en.wikipedia.org/wiki/CBOR [Bincode]: https://github.com/servo/bincode @@ -31,4 +32,4 @@ [`teloxide::utils::UpState`]: utils::UpState [`teloxide-core` features]: https://docs.rs/teloxide-core/latest/teloxide_core/#cargo-features -[`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler \ No newline at end of file +[`DispatcherBuilder::enable_ctrlc_handler`]: dispatching::DispatcherBuilder::enable_ctrlc_handler