Feature flags of Redis crate // Lib.rs

Cargo Features

[dependencies]
redis = { version = "0.30.0", default-features = false, features = ["acl", "geospatial", "json", "cluster", "script", "tls-native-tls", "tls-rustls", "tls-rustls-insecure", "tls-rustls-webpki-roots", "smol-comp", "smol-native-tls-comp", "smol-rustls-comp", "tokio-comp", "tokio-native-tls-comp", "tokio-rustls-comp", "connection-manager", "streams", "cluster-async", "keep-alive", "sentinel", "disable-client-setinfo", "cache-aio", "r2d2", "bb8", "tls", "async-std-tls-comp", "async-std-comp", "async-std-native-tls-comp", "async-std-rustls-comp", "aio", "rust_decimal", "bigdecimal", "ahash", "uuid", "hashbrown"] }

default = acl, geospatial, keep-alive, script, streams

These default features are set whenever redis is added without default-features = false somewhere in the dependency tree.

acl default

Affects redis::acl…

geospatial default

Affects redis::geo…

json

Enables serde_json and derive of serde

Only needed for RedisJSON Support

cluster cluster-async?

Enables crc16 and rand

crc16:
Only needed for cluster

Affects redis::cluster, redis::cluster_routing…

script default

Enables sha1_smol

We need this for script support

tls-native-tls async-std-native-tls-comp? smol-native-tls-comp? tls? tokio-native-tls-comp?

Enables native-tls

Only needed for native tls

tls-rustls async-std-rustls-comp? smol-rustls-comp? tls-rustls-insecure? tls-rustls-webpki-roots? tokio-rustls-comp?

Enables rustls-native-certs and ring and std of rustls

Only needed for rustls

tls-rustls-insecure = tls-rustls

tls-rustls-webpki-roots = tls-rustls

Enables webpki-roots

smol-comp smol-native-tls-comp? smol-rustls-comp? = aio

Enables async-io, smol, and smol-timeout

smol:
only needed for smol support

Affects aio::smol, runtime::prefer_smol, runtime::prefer_async_std, runtime::prefer_tokio…

smol-native-tls-comp = smol-comp, tls-native-tls

Enables async-native-tls

smol-rustls-comp = smol-comp, tls-rustls

Enables futures-rustls

tokio-comp tokio-native-tls-comp? tokio-rustls-comp? = aio

Enables tokio

Affects aio::tokio, runtime::prefer_smol, runtime::prefer_async_std, runtime::prefer_tokio…

tokio-native-tls-comp = tls-native-tls, tokio-comp

Enables tokio-native-tls

tokio-rustls-comp = tls-rustls, tokio-comp

Enables tokio-rustls

connection-manager = aio

Enables backon and futures-channel

streams default

Affects redis::streams…

cluster-async = aio, cluster

Enables futures-sink and log

futures-sink:
Only needed for cluster-async

Affects redis::cluster_async…

keep-alive default

sentinel

Enables rand

Affects redis::sentinel…

tcp_nodelay num-bigint disable-client-setinfo

cache-aio = aio

Enables lru ^0.13

Affects cmd::CommandCacheConfig, redis::caching…

r2d2

Enables r2d2

Only needed for the r2d2 feature

Affects sentinel::LockedSentinelClient…

bb8

Enables bb8

Only needed for the bb8 feature

tls = tls-native-tls

Deprecated features
use "tls-native-tls" instead

async-std-tls-comp = async-std-native-tls-comp

use "async-std-native-tls-comp" instead

async-std-comp async-std-native-tls-comp? async-std-rustls-comp? = aio

Enables async-std

Only needed for async_std support

Affects aio::async_std, runtime::prefer_smol, runtime::prefer_async_std, runtime::prefer_tokio…

async-std-native-tls-comp async-std-tls-comp? = async-std-comp, tls-native-tls

Enables async-native-tls

async-std-rustls-comp = async-std-comp, tls-rustls

Enables futures-rustls

aio async-std-comp? cache-aio? cluster-async? connection-manager? smol-comp? tokio-comp? = bytes

Instead of specifying "aio", use either "tokio-comp" or "async-std-comp".

Enables cfg-if, futures-util and pin-project-lite, tokio of combine, io-util of tokio, codec of tokio-util

Affects client::AsyncConnectionConfig, cmd::AsyncIter, dns::AsyncDNSResolver, redis::aio, types::RedisFuture…

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

bytes aio?

Enables bytes