ncryptf::deadpool_redis::redis

Struct Connection

Source 
pub struct Connection { /* private fields */ }
Expand description

Represents a stateful redis TCP connection.

Implementations§

Source§

impl Connection

A connection is an object that represents a single redis connection. It provides basic support for sending encoded commands into a redis connection and to read a response from it. It’s bound to a single database and can only be created from the client.

You generally do not much with this object other than passing it to Cmd objects.

Source

pub fn send_packed_command(&mut self, cmd: &[u8]) -> Result<(), RedisError>

Sends an already encoded (packed) command into the TCP socket and does not read a response. This is useful for commands like MONITOR which yield multiple items. This needs to be used with care because it changes the state of the connection.

Source

pub fn recv_response(&mut self) -> Result<Value, RedisError>

Fetches a single response from the connection. This is useful if used in combination with send_packed_command.

Source

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<(), RedisError>

Sets the write timeout for the connection.

If the provided value is None, then send_packed_command call will block indefinitely. It is an error to pass the zero Duration to this method.

Source

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<(), RedisError>

Sets the read timeout for the connection.

If the provided value is None, then recv_response call will block indefinitely. It is an error to pass the zero Duration to this method.

Source

pub fn as_pubsub(&mut self) -> PubSub<'_>

Creates a PubSub instance for this connection.

Trait Implementations§

Source§

impl ConnectionLike for Connection

Source§

fn req_packed_command(&mut self, cmd: &[u8]) -> Result<Value, RedisError>

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.
Source§

fn is_open(&self) -> bool

Returns the connection status. Read more
Source§

fn check_connection(&mut self) -> bool

Check that all connections it has are available (PING internally).
Source§

fn req_command(&mut self, cmd: &Cmd) -> Result<Value, RedisError>

Sends a Cmd into the TCP socket and reads a single response from it.
Source§

impl PubSubCommands for Connection

Source§

fn subscribe<C, F, U>(&mut self, channels: C, func: F) -> Result<U, RedisError>
where F: FnMut(Msg) -> ControlFlow<U>, C: ToRedisArgs,

Subscribe to a list of channels using SUBSCRIBE and run the provided closure for each message received. Read more
Source§

fn psubscribe<P, F, U>(&mut self, patterns: P, func: F) -> Result<U, RedisError>
where F: FnMut(Msg) -> ControlFlow<U>, P: ToRedisArgs,

Subscribe to a list of channels using PSUBSCRIBE and run the provided closure for each message received. Read more

Auto Trait Implementations§

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> 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> Commands for T
where T: ConnectionLike,

Source§

fn get<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn mget<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get values of keys
Source§

fn keys<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Gets all keys matching pattern
Source§

fn set<'a, K, V, RV>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Set the string value of a key.
Source§

fn set_options<'a, K, V, RV>( &mut self, key: K, value: V, options: SetOptions, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Set the string value of a key with options.
Source§

fn set_multiple<'a, K, V, RV>( &mut self, items: &'a [(K, V)], ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, 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>(&mut self, items: &'a [(K, V)]) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Sets multiple keys to their values.
Source§

fn set_ex<'a, K, V, RV>( &mut self, key: K, value: V, seconds: u64, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Set the value and expiration of a key.
Source§

fn pset_ex<'a, K, V, RV>( &mut self, key: K, value: V, milliseconds: u64, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn set_nx<'a, K, V, RV>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn mset_nx<'a, K, V, RV>( &mut self, items: &'a [(K, V)], ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn getset<'a, K, V, RV>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn getrange<'a, K, RV>( &mut self, key: K, from: isize, to: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, offset: isize, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn del<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Delete one or more keys.
Source§

fn exists<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Determine if a key exists.
Source§

fn key_type<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Determine the type of a key.
Source§

fn expire<'a, K, RV>(&mut self, key: K, seconds: i64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Set a key’s time to live in seconds.
Source§

fn expire_at<'a, K, RV>(&mut self, key: K, ts: i64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Set the expiration for a key as a UNIX timestamp.
Source§

fn pexpire<'a, K, RV>(&mut self, key: K, ms: i64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Set a key’s time to live in milliseconds.
Source§

fn pexpire_at<'a, K, RV>(&mut self, key: K, ts: i64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn persist<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Remove the expiration from a key.
Source§

fn ttl<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the expiration time of a key.
Source§

fn pttl<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the expiration time of a key in milliseconds.
Source§

fn get_ex<'a, K, RV>( &mut self, key: K, expire_at: Expiry, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the value of a key and set expiration
Source§

fn get_del<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the value of a key and delete it
Source§

fn rename<'a, K, N, RV>(&mut self, key: K, new_key: N) -> Result<RV, RedisError>
where K: ToRedisArgs, N: ToRedisArgs, RV: FromRedisValue,

Rename a key.
Source§

fn rename_nx<'a, K, N, RV>( &mut self, key: K, new_key: N, ) -> Result<RV, RedisError>
where K: ToRedisArgs, N: ToRedisArgs, 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>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Append a value to a key.
Source§

fn incr<'a, K, V, RV>(&mut self, key: K, delta: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, 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>(&mut self, key: K, delta: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn setbit<'a, K, RV>( &mut self, key: K, offset: usize, value: bool, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn getbit<'a, K, RV>(&mut self, key: K, offset: usize) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn bitcount<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Count set bits in a string.
Source§

fn bitcount_range<'a, K, RV>( &mut self, key: K, start: usize, end: usize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Count set bits in a string in a range.
Source§

fn bit_and<'a, D, S, RV>( &mut self, dstkey: D, srckeys: S, ) -> Result<RV, RedisError>
where D: ToRedisArgs, S: ToRedisArgs, 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>( &mut self, dstkey: D, srckeys: S, ) -> Result<RV, RedisError>
where D: ToRedisArgs, S: ToRedisArgs, 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>( &mut self, dstkey: D, srckeys: S, ) -> Result<RV, RedisError>
where D: ToRedisArgs, S: ToRedisArgs, 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>( &mut self, dstkey: D, srckey: S, ) -> Result<RV, RedisError>
where D: ToRedisArgs, S: ToRedisArgs, 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>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the length of the value stored in a key.
Source§

fn hget<'a, K, F, RV>(&mut self, key: K, field: F) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue,

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

fn hdel<'a, K, F, RV>(&mut self, key: K, field: F) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue,

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

fn hset<'a, K, F, V, RV>( &mut self, key: K, field: F, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Sets a single field in a hash.
Source§

fn hset_nx<'a, K, F, V, RV>( &mut self, key: K, field: F, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn hset_multiple<'a, K, F, V, RV>( &mut self, key: K, items: &'a [(F, V)], ) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Sets a multiple fields in a hash.
Source§

fn hincr<'a, K, F, D, RV>( &mut self, key: K, field: F, delta: D, ) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue,

Increments a value.
Source§

fn hexists<'a, K, F, RV>(&mut self, key: K, field: F) -> Result<RV, RedisError>
where K: ToRedisArgs, F: ToRedisArgs, RV: FromRedisValue,

Checks if a field in a hash exists.
Source§

fn hkeys<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Gets all the keys in a hash.
Source§

fn hvals<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Gets all the values in a hash.
Source§

fn hgetall<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Gets all the fields and values in a hash.
Source§

fn hlen<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Gets the length of a hash.
Source§

fn blmove<'a, S, D, RV>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> Result<RV, RedisError>
where S: ToRedisArgs, D: ToRedisArgs, 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>( &mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>(&mut self, key: K, timeout: f64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn brpop<'a, K, RV>(&mut self, key: K, timeout: f64) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn brpoplpush<'a, S, D, RV>( &mut self, srckey: S, dstkey: D, timeout: f64, ) -> Result<RV, RedisError>
where S: ToRedisArgs, D: ToRedisArgs, 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>(&mut self, key: K, index: isize) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get an element from a list by its index.
Source§

fn linsert_before<'a, K, P, V, RV>( &mut self, key: K, pivot: P, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Insert an element before another element in a list.
Source§

fn linsert_after<'a, K, P, V, RV>( &mut self, key: K, pivot: P, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Insert an element after another element in a list.
Source§

fn llen<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Returns the length of the list stored at key.
Source§

fn lmove<'a, S, D, RV>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> Result<RV, RedisError>
where S: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue,

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

fn lmpop<'a, K, RV>( &mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, count: Option<NonZero<usize>>, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, value: V, options: LposOptions, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn lpush<'a, K, V, RV>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn lpush_exists<'a, K, V, RV>( &mut self, key: K, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, 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>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Returns the specified elements of the list stored at key.
Source§

fn lrem<'a, K, V, RV>( &mut self, key: K, count: isize, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn ltrim<'a, K, RV>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, index: isize, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

Sets the list element at index to value
Source§

fn rpop<'a, K, RV>( &mut self, key: K, count: Option<NonZero<usize>>, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, dstkey: D, ) -> Result<RV, RedisError>
where K: ToRedisArgs, D: ToRedisArgs, RV: FromRedisValue,

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

fn rpush<'a, K, V, RV>(&mut self, key: K, value: V) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, RV: FromRedisValue,

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

fn rpush_exists<'a, K, V, RV>( &mut self, key: K, value: V, ) -> Result<RV, RedisError>
where K: ToRedisArgs, V: ToRedisArgs, 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>(&mut self, key: K, member: M) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Add one or more members to a set.
Source§

fn scard<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the number of members in a set.
Source§

fn sdiff<'a, K, RV>(&mut self, keys: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Subtract multiple sets.
Source§

fn sdiffstore<'a, D, K, RV>( &mut self, dstkey: D, keys: K, ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue,

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

fn sinter<'a, K, RV>(&mut self, keys: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Intersect multiple sets.
Source§

fn sinterstore<'a, D, K, RV>( &mut self, dstkey: D, keys: K, ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue,

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

fn sismember<'a, K, M, RV>( &mut self, key: K, member: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Determine if a given value is a member of a set.
Source§

fn smismember<'a, K, M, RV>( &mut self, key: K, members: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Determine if given values are members of a set.
Source§

fn smembers<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get all the members in a set.
Source§

fn smove<'a, S, D, M, RV>( &mut self, srckey: S, dstkey: D, member: M, ) -> Result<RV, RedisError>
where S: ToRedisArgs, D: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Move a member from one set to another.
Source§

fn spop<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Remove and return a random member from a set.
Source§

fn srandmember<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get one random member from a set.
Source§

fn srandmember_multiple<'a, K, RV>( &mut self, key: K, count: usize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get multiple random members from a set.
Source§

fn srem<'a, K, M, RV>(&mut self, key: K, member: M) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Remove one or more members from a set.
Source§

fn sunion<'a, K, RV>(&mut self, keys: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Add multiple sets.
Source§

fn sunionstore<'a, D, K, RV>( &mut self, dstkey: D, keys: K, ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, RV: FromRedisValue,

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

fn zadd<'a, K, S, M, RV>( &mut self, key: K, member: M, score: S, ) -> Result<RV, RedisError>
where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, 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>( &mut self, key: K, items: &'a [(S, M)], ) -> Result<RV, RedisError>
where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zcard<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Get the number of members in a sorted set.
Source§

fn zcount<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zincr<'a, K, M, D, RV>( &mut self, key: K, member: M, delta: D, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn bzpopmax<'a, K, RV>( &mut self, key: K, timeout: f64, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>(&mut self, key: K, count: isize) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn bzpopmin<'a, K, RV>( &mut self, key: K, timeout: f64, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>(&mut self, key: K, count: isize) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn bzmpop_max<'a, K, RV>( &mut self, timeout: f64, keys: &'a [K], count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, keys: &'a [K], count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, timeout: f64, keys: &'a [K], count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, keys: &'a [K], count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, count: Option<isize>, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn zrandmember_withscores<'a, K, RV>( &mut self, key: K, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn zrange<'a, K, RV>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn zrange_withscores<'a, K, RV>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn zrangebylex<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zrangebylex_limit<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, 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>( &mut self, key: K, max: MM, min: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zrevrangebylex_limit<'a, K, MM, M, RV>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, 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>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zrangebyscore_withscores<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zrangebyscore_limit<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, 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>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zrank<'a, K, M, RV>(&mut self, key: K, member: M) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Determine the index of a member in a sorted set.
Source§

fn zrem<'a, K, M, RV>(&mut self, key: K, members: M) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

Remove one or more members from a sorted set.
Source§

fn zrembylex<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zremrangebyrank<'a, K, RV>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn zrembyscore<'a, K, M, MM, RV>( &mut self, key: K, min: M, max: MM, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs, RV: FromRedisValue,

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

fn zrevrange<'a, K, RV>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, start: isize, stop: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, 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>( &mut self, key: K, max: MM, min: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zrevrangebyscore_withscores<'a, K, MM, M, RV>( &mut self, key: K, max: MM, min: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zrevrangebyscore_limit<'a, K, MM, M, RV>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, 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>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> Result<RV, RedisError>
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zrevrank<'a, K, M, RV>( &mut self, key: K, member: M, ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, 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>(&mut self, key: K, member: M) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zscore_multiple<'a, K, M, RV>( &mut self, key: K, members: &'a [M], ) -> Result<RV, RedisError>
where K: ToRedisArgs, M: ToRedisArgs, RV: FromRedisValue,

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

fn zunionstore<'a, D, K, RV>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [K], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> Result<RV, RedisError>
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs, 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>(&mut self, key: K, element: E) -> Result<RV, RedisError>
where K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue,

Adds the specified elements to the specified HyperLogLog.
Source§

fn pfcount<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn pfmerge<'a, D, S, RV>( &mut self, dstkey: D, srckeys: S, ) -> Result<RV, RedisError>
where D: ToRedisArgs, S: ToRedisArgs, RV: FromRedisValue,

Merge N different HyperLogLogs into a single one.
Source§

fn publish<'a, K, E, RV>( &mut self, channel: K, message: E, ) -> Result<RV, RedisError>
where K: ToRedisArgs, E: ToRedisArgs, RV: FromRedisValue,

Posts a message to the given channel.
Source§

fn object_encoding<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Returns the encoding of a key.
Source§

fn object_idletime<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

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

fn object_freq<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Returns the logarithmic access frequency counter of a key.
Source§

fn object_refcount<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Returns the reference count of a key.
Source§

fn xrevrange_all<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>
where K: ToRedisArgs, 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) -> Result<Iter<'_, RV>, RedisError>
where RV: FromRedisValue,

Incrementally iterate the keys space.
Source§

fn scan_match<P, RV>(&mut self, pattern: P) -> Result<Iter<'_, RV>, RedisError>
where P: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate the keys space for keys matching a pattern.
Source§

fn hscan<K, RV>(&mut self, key: K) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate hash fields and associated values.
Source§

fn hscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue,

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

fn sscan<K, RV>(&mut self, key: K) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate set elements.
Source§

fn sscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate set elements for elements matching a pattern.
Source§

fn zscan<K, RV>(&mut self, key: K) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate sorted set elements.
Source§

fn zscan_match<K, P, RV>( &mut self, key: K, pattern: P, ) -> Result<Iter<'_, RV>, RedisError>
where K: ToRedisArgs, P: ToRedisArgs, RV: FromRedisValue,

Incrementally iterate sorted set elements for elements matching a pattern.
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,