Struct Connection

Source
pub struct Connection<C = Pin<Box<dyn AsyncStream + Send + Sync>>> { /* private fields */ }
๐Ÿ‘ŽDeprecated: aio::Connection is deprecated. Use aio::MultiplexedConnection instead.
Expand description

Represents a stateful redis TCP connection.

Implementationsยง

Sourceยง

impl<C> Connection<C>
where C: Unpin + AsyncRead + AsyncWrite + Send,

Source

pub async fn new( connection_info: &RedisConnectionInfo, con: C, ) -> Result<Connection<C>, RedisError>

Constructs a new Connection out of a AsyncRead + AsyncWrite object and a RedisConnectionInfo

Source

pub fn into_pubsub(self) -> PubSub<C>

Converts this Connection into PubSub.

Source

pub fn into_monitor(self) -> Monitor<C>

Converts this Connection into Monitor

Trait Implementationsยง

Sourceยง

impl<C> ConnectionLike for Connection<C>
where C: Unpin + AsyncRead + AsyncWrite + Send,

Sourceยง

fn req_packed_command<'a>( &'a mut self, cmd: &'a Cmd, ) -> Pin<Box<dyn Future<Output = Result<Value, RedisError>> + Send + 'a>>

Sends an already encoded (packed) command into the TCP socket and reads the single response from it.
Sourceยง

fn get_db(&self) -> i64

Returns the database this connection is bound to. Note that this information might be unreliable because itโ€™s initially cached and also might be incorrect if the connection like object is not actually connected.

Auto Trait Implementationsยง

ยง

impl<C> Freeze for Connection<C>
where C: Freeze,

ยง

impl<C = Pin<Box<dyn AsyncStream + Send + Sync>>> !RefUnwindSafe for Connection<C>

ยง

impl<C> Send for Connection<C>
where C: Send,

ยง

impl<C> Sync for Connection<C>
where C: Sync,

ยง

impl<C> Unpin for Connection<C>
where C: Unpin,

ยง

impl<C = Pin<Box<dyn AsyncStream + Send + Sync>>> !UnwindSafe for Connection<C>

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> AsyncCommands for T
where T: ConnectionLike + Send,

Sourceยง

fn get<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the value of a key. If key is a vec this becomes an MGET.
Sourceยง

fn mget<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get values of keys
Sourceยง

fn keys<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets all keys matching pattern
Sourceยง

fn set<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the string value of a key.
Sourceยง

fn set_options<'a, K, V, RV>( &'a mut self, key: K, value: V, options: SetOptions, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the string value of a key with options.
Sourceยง

fn set_multiple<'a, K, V, RV>( &'a mut self, items: &'a [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

๐Ÿ‘ŽDeprecated since 0.22.4: Renamed to mset() to reflect Redis name
Sets multiple keys to their values.
Sourceยง

fn mset<'a, K, V, RV>( &'a mut self, items: &'a [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets multiple keys to their values.
Sourceยง

fn set_ex<'a, K, V, RV>( &'a mut self, key: K, value: V, seconds: u64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the value and expiration of a key.
Sourceยง

fn pset_ex<'a, K, V, RV>( &'a mut self, key: K, value: V, milliseconds: u64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the value and expiration in milliseconds of a key.
Sourceยง

fn set_nx<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the value of a key, only if the key does not exist
Sourceยง

fn mset_nx<'a, K, V, RV>( &'a mut self, items: &'a [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets multiple keys to their values failing if at least one already exists.
Sourceยง

fn getset<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the string value of a key and return its old value.
Sourceยง

fn getrange<'a, K, RV>( &'a mut self, key: K, from: isize, to: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value.
Sourceยง

fn setrange<'a, K, V, RV>( &'a mut self, key: K, offset: isize, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Overwrite the part of the value stored in key at the specified offset.
Sourceยง

fn del<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Delete one or more keys.
Sourceยง

fn exists<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine if a key exists.
Sourceยง

fn key_type<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine the type of a key.
Sourceยง

fn expire<'a, K, RV>( &'a mut self, key: K, seconds: i64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set a keyโ€™s time to live in seconds.
Sourceยง

fn expire_at<'a, K, RV>( &'a mut self, key: K, ts: i64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the expiration for a key as a UNIX timestamp.
Sourceยง

fn pexpire<'a, K, RV>( &'a mut self, key: K, ms: i64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set a keyโ€™s time to live in milliseconds.
Sourceยง

fn pexpire_at<'a, K, RV>( &'a mut self, key: K, ts: i64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Set the expiration for a key as a UNIX timestamp in milliseconds.
Sourceยง

fn persist<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove the expiration from a key.
Sourceยง

fn ttl<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the expiration time of a key.
Sourceยง

fn pttl<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the expiration time of a key in milliseconds.
Sourceยง

fn get_ex<'a, K, RV>( &'a mut self, key: K, expire_at: Expiry, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the value of a key and set expiration
Sourceยง

fn get_del<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the value of a key and delete it
Sourceยง

fn rename<'a, K, N, RV>( &'a mut self, key: K, new_key: N, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, N: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Rename a key.
Sourceยง

fn rename_nx<'a, K, N, RV>( &'a mut self, key: K, new_key: N, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, N: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Rename a key, only if the new key does not exist.
Unlink one or more keys.
Sourceยง

fn append<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Append a value to a key.
Sourceยง

fn incr<'a, K, V, RV>( &'a mut self, key: K, delta: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Increment the numeric value of a key by the given amount. This issues a INCRBY or INCRBYFLOAT depending on the type.
Sourceยง

fn decr<'a, K, V, RV>( &'a mut self, key: K, delta: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Decrement the numeric value of a key by the given amount.
Sourceยง

fn setbit<'a, K, RV>( &'a mut self, key: K, offset: usize, value: bool, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets or clears the bit at offset in the string value stored at key.
Sourceยง

fn getbit<'a, K, RV>( &'a mut self, key: K, offset: usize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the bit value at offset in the string value stored at key.
Sourceยง

fn bitcount<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Count set bits in a string.
Sourceยง

fn bitcount_range<'a, K, RV>( &'a mut self, key: K, start: usize, end: usize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Count set bits in a string in a range.
Sourceยง

fn bit_and<'a, D, S, RV>( &'a mut self, dstkey: D, srckeys: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key.
Sourceยง

fn bit_or<'a, D, S, RV>( &'a mut self, dstkey: D, srckeys: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key.
Sourceยง

fn bit_xor<'a, D, S, RV>( &'a mut self, dstkey: D, srckeys: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key.
Sourceยง

fn bit_not<'a, D, S, RV>( &'a mut self, dstkey: D, srckey: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Perform a bitwise NOT of the key (containing string values) and store the result in the destination key.
Sourceยง

fn strlen<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the length of the value stored in a key.
Sourceยง

fn hget<'a, K, F, RV>( &'a mut self, key: K, field: F, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets a single (or multiple) fields from a hash.
Sourceยง

fn hdel<'a, K, F, RV>( &'a mut self, key: K, field: F, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Deletes a single (or multiple) fields from a hash.
Sourceยง

fn hset<'a, K, F, V, RV>( &'a mut self, key: K, field: F, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets a single field in a hash.
Sourceยง

fn hset_nx<'a, K, F, V, RV>( &'a mut self, key: K, field: F, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets a single field in a hash if it does not exist.
Sourceยง

fn hset_multiple<'a, K, F, V, RV>( &'a mut self, key: K, items: &'a [(F, V)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets a multiple fields in a hash.
Sourceยง

fn hincr<'a, K, F, D, RV>( &'a mut self, key: K, field: F, delta: D, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Increments a value.
Sourceยง

fn hexists<'a, K, F, RV>( &'a mut self, key: K, field: F, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, F: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Checks if a field in a hash exists.
Sourceยง

fn hkeys<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets all the keys in a hash.
Sourceยง

fn hvals<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets all the values in a hash.
Sourceยง

fn hgetall<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets all the fields and values in a hash.
Sourceยง

fn hlen<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Gets the length of a hash.
Sourceยง

fn blmove<'a, S, D, RV>( &'a mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where S: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pop an element from a list, push it to another list and return it; or block until one is available
Sourceยง

fn blmpop<'a, K, RV>( &'a mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pops count elements from the first non-empty list key from the list of provided key names; or blocks until one is available.
Sourceยง

fn blpop<'a, K, RV>( &'a mut self, key: K, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove and get the first element in a list, or block until one is available.
Sourceยง

fn brpop<'a, K, RV>( &'a mut self, key: K, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove and get the last element in a list, or block until one is available.
Sourceยง

fn brpoplpush<'a, S, D, RV>( &'a mut self, srckey: S, dstkey: D, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where S: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pop a value from a list, push it to another list and return it; or block until one is available.
Sourceยง

fn lindex<'a, K, RV>( &'a mut self, key: K, index: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get an element from a list by its index.
Sourceยง

fn linsert_before<'a, K, P, V, RV>( &'a mut self, key: K, pivot: P, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, P: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Insert an element before another element in a list.
Sourceยง

fn linsert_after<'a, K, P, V, RV>( &'a mut self, key: K, pivot: P, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, P: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Insert an element after another element in a list.
Sourceยง

fn llen<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the length of the list stored at key.
Sourceยง

fn lmove<'a, S, D, RV>( &'a mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where S: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pop an element a list, push it to another list and return it
Sourceยง

fn lmpop<'a, K, RV>( &'a mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pops count elements from the first non-empty list key from the list of provided key names.
Sourceยง

fn lpop<'a, K, RV>( &'a mut self, key: K, count: Option<NonZero<usize>>, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns the up to count first elements of the list stored at key. Read more
Sourceยง

fn lpos<'a, K, V, RV>( &'a mut self, key: K, value: V, options: LposOptions, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the index of the first matching value of the list stored at key.
Sourceยง

fn lpush<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Insert all the specified values at the head of the list stored at key.
Sourceยง

fn lpush_exists<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Inserts a value at the head of the list stored at key, only if key already exists and holds a list.
Sourceยง

fn lrange<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the specified elements of the list stored at key.
Sourceยง

fn lrem<'a, K, V, RV>( &'a mut self, key: K, count: isize, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes the first count occurrences of elements equal to value from the list stored at key.
Sourceยง

fn ltrim<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Trim an existing list so that it will contain only the specified range of elements specified.
Sourceยง

fn lset<'a, K, V, RV>( &'a mut self, key: K, index: isize, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Sets the list element at index to value
Sourceยง

fn rpop<'a, K, RV>( &'a mut self, key: K, count: Option<NonZero<usize>>, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns the up to count last elements of the list stored at key Read more
Sourceยง

fn rpoplpush<'a, K, D, RV>( &'a mut self, key: K, dstkey: D, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Pop a value from a list, push it to another list and return it.
Sourceยง

fn rpush<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Insert all the specified values at the tail of the list stored at key.
Sourceยง

fn rpush_exists<'a, K, V, RV>( &'a mut self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, V: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Inserts value at the tail of the list stored at key, only if key already exists and holds a list.
Sourceยง

fn sadd<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Add one or more members to a set.
Sourceยง

fn scard<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the number of members in a set.
Sourceยง

fn sdiff<'a, K, RV>( &'a mut self, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Subtract multiple sets.
Sourceยง

fn sdiffstore<'a, D, K, RV>( &'a mut self, dstkey: D, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Subtract multiple sets and store the resulting set in a key.
Sourceยง

fn sinter<'a, K, RV>( &'a mut self, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Intersect multiple sets.
Sourceยง

fn sinterstore<'a, D, K, RV>( &'a mut self, dstkey: D, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Intersect multiple sets and store the resulting set in a key.
Sourceยง

fn sismember<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine if a given value is a member of a set.
Sourceยง

fn smismember<'a, K, M, RV>( &'a mut self, key: K, members: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine if given values are members of a set.
Sourceยง

fn smembers<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get all the members in a set.
Sourceยง

fn smove<'a, S, D, M, RV>( &'a mut self, srckey: S, dstkey: D, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where S: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Move a member from one set to another.
Sourceยง

fn spop<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove and return a random member from a set.
Sourceยง

fn srandmember<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get one random member from a set.
Sourceยง

fn srandmember_multiple<'a, K, RV>( &'a mut self, key: K, count: usize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get multiple random members from a set.
Sourceยง

fn srem<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove one or more members from a set.
Sourceยง

fn sunion<'a, K, RV>( &'a mut self, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Add multiple sets.
Sourceยง

fn sunionstore<'a, D, K, RV>( &'a mut self, dstkey: D, keys: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Add multiple sets and store the resulting set in a key.
Sourceยง

fn zadd<'a, K, S, M, RV>( &'a mut self, key: K, member: M, score: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Add one member to a sorted set, or update its score if it already exists.
Sourceยง

fn zadd_multiple<'a, K, S, M, RV>( &'a mut self, key: K, items: &'a [(S, M)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Add multiple members to a sorted set, or update its score if it already exists.
Sourceยง

fn zcard<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the number of members in a sorted set.
Sourceยง

fn zcount<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Count the members in a sorted set with scores within the given values.
Sourceยง

fn zincr<'a, K, M, D, RV>( &'a mut self, key: K, member: M, delta: D, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, D: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Increments the member in a sorted set at key by delta. If the member does not exist, it is added with delta as its score.
Sourceยง

fn zinterstore<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Intersect multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.
Sourceยง

fn zinterstore_min<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Intersect multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.
Sourceยง

fn zinterstore_max<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Intersect multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.
Sourceยง

fn zinterstore_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zinterstore, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn zinterstore_min_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zinterstore_min, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn zinterstore_max_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zinterstore_max, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn zlexcount<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Count the number of members in a sorted set between a given lexicographical range.
Sourceยง

fn bzpopmax<'a, K, RV>( &'a mut self, key: K, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns the member with the highest score in a sorted set. Blocks until a member is available otherwise.
Sourceยง

fn zpopmax<'a, K, RV>( &'a mut self, key: K, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the highest scores in a sorted set
Sourceยง

fn bzpopmin<'a, K, RV>( &'a mut self, key: K, timeout: f64, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns the member with the lowest score in a sorted set. Blocks until a member is available otherwise.
Sourceยง

fn zpopmin<'a, K, RV>( &'a mut self, key: K, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the lowest scores in a sorted set
Sourceยง

fn bzmpop_max<'a, K, RV>( &'a mut self, timeout: f64, keys: &'a [K], count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise.
Sourceยง

fn zmpop_max<'a, K, RV>( &'a mut self, keys: &'a [K], count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the highest scores, from the first non-empty sorted set in the provided list of key names.
Sourceยง

fn bzmpop_min<'a, K, RV>( &'a mut self, timeout: f64, keys: &'a [K], count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names. Blocks until a member is available otherwise.
Sourceยง

fn zmpop_min<'a, K, RV>( &'a mut self, keys: &'a [K], count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Removes and returns up to count members with the lowest scores, from the first non-empty sorted set in the provided list of key names.
Sourceยง

fn zrandmember<'a, K, RV>( &'a mut self, key: K, count: Option<isize>, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return up to count random members in a sorted set (or 1 if count == None)
Sourceยง

fn zrandmember_withscores<'a, K, RV>( &'a mut self, key: K, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return up to count random members in a sorted set with scores
Sourceยง

fn zrange<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by index
Sourceยง

fn zrange_withscores<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by index with scores.
Sourceยง

fn zrangebylex<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by lexicographical range.
Sourceยง

fn zrangebylex_limit<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by lexicographical range with offset and limit.
Sourceยง

fn zrevrangebylex<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by lexicographical range.
Sourceยง

fn zrevrangebylex_limit<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by lexicographical range with offset and limit.
Sourceยง

fn zrangebyscore<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score.
Sourceยง

fn zrangebyscore_withscores<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with scores.
Sourceยง

fn zrangebyscore_limit<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with limit.
Sourceยง

fn zrangebyscore_limit_withscores<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with limit with scores.
Sourceยง

fn zrank<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine the index of a member in a sorted set.
Sourceยง

fn zrem<'a, K, M, RV>( &'a mut self, key: K, members: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove one or more members from a sorted set.
Sourceยง

fn zrembylex<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove all members in a sorted set between the given lexicographical range.
Sourceยง

fn zremrangebyrank<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove all members in a sorted set within the given indexes.
Sourceยง

fn zrembyscore<'a, K, M, MM, RV>( &'a mut self, key: K, min: M, max: MM, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Remove all members in a sorted set within the given scores.
Sourceยง

fn zrevrange<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by index, with scores ordered from high to low.
Sourceยง

fn zrevrange_withscores<'a, K, RV>( &'a mut self, key: K, start: isize, stop: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by index, with scores ordered from high to low.
Sourceยง

fn zrevrangebyscore<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score.
Sourceยง

fn zrevrangebyscore_withscores<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with scores.
Sourceยง

fn zrevrangebyscore_limit<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with limit.
Sourceยง

fn zrevrangebyscore_limit_withscores<'a, K, MM, M, RV>( &'a mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, MM: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return a range of members in a sorted set, by score with limit with scores.
Sourceยง

fn zrevrank<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Determine the index of a member in a sorted set, with scores ordered from high to low.
Sourceยง

fn zscore<'a, K, M, RV>( &'a mut self, key: K, member: M, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the score associated with the given member in a sorted set.
Sourceยง

fn zscore_multiple<'a, K, M, RV>( &'a mut self, key: K, members: &'a [M], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, M: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Get the scores associated with multiple members in a sorted set.
Sourceยง

fn zunionstore<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Unions multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function.
Sourceยง

fn zunionstore_min<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Unions multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function.
Sourceยง

fn zunionstore_max<'a, D, K, RV>( &'a mut self, dstkey: D, keys: &'a [K], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Unions multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function.
Sourceยง

fn zunionstore_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zunionstore, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn zunionstore_min_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zunionstore_min, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn zunionstore_max_weights<'a, D, K, W, RV>( &'a mut self, dstkey: D, keys: &'a [(K, W)], ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, K: ToRedisArgs + Send + Sync + 'a, W: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Commands::zunionstore_max, but with the ability to specify a multiplication factor for each sorted set by pairing one with each key in a tuple.
Sourceยง

fn pfadd<'a, K, E, RV>( &'a mut self, key: K, element: E, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, E: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Adds the specified elements to the specified HyperLogLog.
Sourceยง

fn pfcount<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
Sourceยง

fn pfmerge<'a, D, S, RV>( &'a mut self, dstkey: D, srckeys: S, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where D: ToRedisArgs + Send + Sync + 'a, S: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Merge N different HyperLogLogs into a single one.
Sourceยง

fn publish<'a, K, E, RV>( &'a mut self, channel: K, message: E, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, E: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Posts a message to the given channel.
Sourceยง

fn object_encoding<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the encoding of a key.
Sourceยง

fn object_idletime<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the time in seconds since the last access of a key.
Sourceยง

fn object_freq<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the logarithmic access frequency counter of a key.
Sourceยง

fn object_refcount<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

Returns the reference count of a key.
Sourceยง

fn xrevrange_all<'a, K, RV>( &'a mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<RV, RedisError>> + Send + 'a>>
where K: ToRedisArgs + Send + Sync + 'a, RV: FromRedisValue,

This is the reverse version of xrange_all. The same rules apply for start and end here. Read more
Sourceยง

fn scan<RV>( &mut self, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>
where RV: FromRedisValue,

Incrementally iterate the keys space.
Sourceยง

fn scan_match<P, RV>( &mut self, pattern: P, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate set elements for elements matching a pattern.
Sourceยง

fn hscan<K, RV>( &mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate hash fields and associated values.
Sourceยง

fn hscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate hash fields and associated values for field names matching a pattern.
Sourceยง

fn sscan<K, RV>( &mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate set elements.
Sourceยง

fn sscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate set elements for elements matching a pattern.
Sourceยง

fn zscan<K, RV>( &mut self, key: K, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate sorted set elements.
Sourceยง

fn zscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Pin<Box<dyn Future<Output = Result<AsyncIter<'_, RV>, RedisError>> + Send + '_>>

Incrementally iterate sorted set elements for elements matching a pattern.
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> IntoCollection<T> for T

Sourceยง

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
Sourceยง

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

Sourceยง

impl<T> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

impl<T> Paint for T
where T: ?Sized,

Sourceยง

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

ยงExample

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Sourceยง

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

ยงExample
println!("{}", value.primary());
Sourceยง

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

ยงExample
println!("{}", value.fixed(color));
Sourceยง

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

ยงExample
println!("{}", value.rgb(r, g, b));
Sourceยง

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

ยงExample
println!("{}", value.black());
Sourceยง

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

ยงExample
println!("{}", value.red());
Sourceยง

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

ยงExample
println!("{}", value.green());
Sourceยง

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

ยงExample
println!("{}", value.yellow());
Sourceยง

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

ยงExample
println!("{}", value.blue());
Sourceยง

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

ยงExample
println!("{}", value.magenta());
Sourceยง

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

ยงExample
println!("{}", value.cyan());
Sourceยง

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

ยงExample
println!("{}", value.white());
Sourceยง

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

ยงExample
println!("{}", value.bright_black());
Sourceยง

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

ยงExample
println!("{}", value.bright_red());
Sourceยง

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

ยงExample
println!("{}", value.bright_green());
Sourceยง

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

ยงExample
println!("{}", value.bright_yellow());
Sourceยง

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

ยงExample
println!("{}", value.bright_blue());
Sourceยง

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

ยงExample
println!("{}", value.bright_magenta());
Sourceยง

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

ยงExample
println!("{}", value.bright_cyan());
Sourceยง

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

ยงExample
println!("{}", value.bright_white());
Sourceยง

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

ยงExample

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Sourceยง

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Primary].

ยงExample
println!("{}", value.on_primary());
Sourceยง

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

ยงExample
println!("{}", value.on_fixed(color));
Sourceยง

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

ยงExample
println!("{}", value.on_rgb(r, g, b));
Sourceยง

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

ยงExample
println!("{}", value.on_black());
Sourceยง

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

ยงExample
println!("{}", value.on_red());
Sourceยง

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

ยงExample
println!("{}", value.on_green());
Sourceยง

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

ยงExample
println!("{}", value.on_yellow());
Sourceยง

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

ยงExample
println!("{}", value.on_blue());
Sourceยง

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

ยงExample
println!("{}", value.on_magenta());
Sourceยง

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

ยงExample
println!("{}", value.on_cyan());
Sourceยง

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

ยงExample
println!("{}", value.on_white());
Sourceยง

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

ยงExample
println!("{}", value.on_bright_black());
Sourceยง

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

ยงExample
println!("{}", value.on_bright_red());
Sourceยง

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

ยงExample
println!("{}", value.on_bright_green());
Sourceยง

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

ยงExample
println!("{}", value.on_bright_yellow());
Sourceยง

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

ยงExample
println!("{}", value.on_bright_blue());
Sourceยง

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

ยงExample
println!("{}", value.on_bright_magenta());
Sourceยง

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

ยงExample
println!("{}", value.on_bright_cyan());
Sourceยง

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

ยงExample
println!("{}", value.on_bright_white());
Sourceยง

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

ยงExample

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Sourceยง

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

ยงExample
println!("{}", value.bold());
Sourceยง

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

ยงExample
println!("{}", value.dim());
Sourceยง

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

ยงExample
println!("{}", value.italic());
Sourceยง

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

ยงExample
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

ยงExample
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

ยงExample
println!("{}", value.rapid_blink());
Sourceยง

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

ยงExample
println!("{}", value.invert());
Sourceยง

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

ยงExample
println!("{}", value.conceal());
Sourceยง

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

ยงExample
println!("{}", value.strike());
Sourceยง

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

ยงExample

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Sourceยง

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

ยงExample
println!("{}", value.mask());
Sourceยง

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

ยงExample
println!("{}", value.wrap());
Sourceยง

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

ยงExample
println!("{}", value.linger());
Sourceยง

fn clear(&self) -> Painted<&T>

๐Ÿ‘ŽDeprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk :: Clear].

ยงExample
println!("{}", value.clear());
Sourceยง

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

ยงExample
println!("{}", value.resetting());
Sourceยง

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

ยงExample
println!("{}", value.bright());
Sourceยง

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

ยงExample
println!("{}", value.on_bright());
Sourceยง

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

ยงExample

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Sourceยง

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Sourceยง

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<T> ErasedDestructor for T
where T: 'static,