ncryptf::deadpool_redis::redis

Struct Pipeline

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

Represents a redis command pipeline.

Implementations§

Source§

impl Pipeline

A pipeline allows you to send multiple commands in one go to the redis server. API wise it’s very similar to just using a command but it allows multiple commands to be chained and some features such as iteration are not available.

Basic example:

let ((k1, k2),) : ((i32, i32),) = redis::pipe()
    .cmd("SET").arg("key_1").arg(42).ignore()
    .cmd("SET").arg("key_2").arg(43).ignore()
    .cmd("MGET").arg(&["key_1", "key_2"]).query(&mut con).unwrap();

As you can see with cmd you can start a new command. By default each command produces a value but for some you can ignore them by calling ignore on the command. That way it will be skipped in the return value which is useful for SET commands and others, which do not have a useful return value.

Source

pub fn new() -> Pipeline

Creates an empty pipeline. For consistency with the cmd api a pipe function is provided as alias.

Source

pub fn with_capacity(capacity: usize) -> Pipeline

Creates an empty pipeline with pre-allocated capacity.

Source

pub fn atomic(&mut self) -> &mut Pipeline

This enables atomic mode. In atomic mode the whole pipeline is enclosed in MULTI/EXEC. From the user’s point of view nothing changes however. This is easier than using MULTI/EXEC yourself as the format does not change.

let (k1, k2) : (i32, i32) = redis::pipe()
    .atomic()
    .cmd("GET").arg("key_1")
    .cmd("GET").arg("key_2").query(&mut con).unwrap();
Source

pub fn get_packed_pipeline(&self) -> Vec<u8> ⓘ

Returns the encoded pipeline commands.

Source

pub fn query<T>(&self, con: &mut dyn ConnectionLike) -> Result<T, RedisError>
where T: FromRedisValue,

Executes the pipeline and fetches the return values. Since most pipelines return different types it’s recommended to use tuple matching to process the results:

let (k1, k2) : (i32, i32) = redis::pipe()
    .cmd("SET").arg("key_1").arg(42).ignore()
    .cmd("SET").arg("key_2").arg(43).ignore()
    .cmd("GET").arg("key_1")
    .cmd("GET").arg("key_2").query(&mut con).unwrap();

NOTE: A Pipeline object may be reused after query() with all the commands as were inserted to them. In order to clear a Pipeline object with minimal memory released/allocated, it is necessary to call the clear() before inserting new commands.

Source

pub async fn query_async<C, T>(&self, con: &mut C) -> Result<T, RedisError>
where T: FromRedisValue, C: ConnectionLike,

Async version of query.

Source

pub fn execute(&self, con: &mut dyn ConnectionLike)

This is a shortcut to query() that does not return a value and will fail the task if the query of the pipeline fails.

This is equivalent to a call of query like this:

let _ : () = redis::pipe().cmd("PING").query(&mut con).unwrap();

NOTE: A Pipeline object may be reused after query() with all the commands as were inserted to them. In order to clear a Pipeline object with minimal memory released/allocated, it is necessary to call the clear() before inserting new commands.

Source§

impl Pipeline

Source

pub fn add_command(&mut self, cmd: Cmd) -> &mut Pipeline

Adds a command to the cluster pipeline.

Source

pub fn cmd(&mut self, name: &str) -> &mut Pipeline

Starts a new command. Functions such as arg then become available to add more arguments to that command.

Source

pub fn cmd_iter(&self) -> impl Iterator<Item = &Cmd>

Returns an iterator over all the commands currently in this pipeline

Source

pub fn ignore(&mut self) -> &mut Pipeline

Instructs the pipeline to ignore the return value of this command. It will still be ensured that it is not an error, but any successful result is just thrown away. This makes result processing through tuples much easier because you do not need to handle all the items you do not care about.

Source

pub fn arg<T>(&mut self, arg: T) -> &mut Pipeline
where T: ToRedisArgs,

Adds an argument to the last started command. This works similar to the arg method of the Cmd object.

Note that this function fails the task if executed on an empty pipeline.

Source

pub fn clear(&mut self)

Clear a pipeline object’s internal data structure.

This allows reusing a pipeline object as a clear object while performing a minimal amount of memory released/reallocated.

Source§

impl Pipeline

Implements common redis commands for pipelines. Unlike the regular commands trait, this returns the pipeline rather than a result directly. Other than that it works the same however.

Source

pub fn get<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn mget<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get values of keys

Source

pub fn keys<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Gets all keys matching pattern

Source

pub fn set<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Set the string value of a key.

Source

pub fn set_options<'a, K, V>( &mut self, key: K, value: V, options: SetOptions, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Set the string value of a key with options.

Source

pub fn set_multiple<'a, K, V>(&mut self, items: &'a [(K, V)]) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

👎Deprecated since 0.22.4: Renamed to mset() to reflect Redis name

Sets multiple keys to their values.

Source

pub fn mset<'a, K, V>(&mut self, items: &'a [(K, V)]) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Sets multiple keys to their values.

Source

pub fn set_ex<'a, K, V>( &mut self, key: K, value: V, seconds: u64, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Set the value and expiration of a key.

Source

pub fn pset_ex<'a, K, V>( &mut self, key: K, value: V, milliseconds: u64, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Set the value and expiration in milliseconds of a key.

Source

pub fn set_nx<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn mset_nx<'a, K, V>(&mut self, items: &'a [(K, V)]) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn getset<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn getrange<'a, K>( &mut self, key: K, from: isize, to: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn setrange<'a, K, V>( &mut self, key: K, offset: isize, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn del<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Delete one or more keys.

Source

pub fn exists<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Determine if a key exists.

Source

pub fn key_type<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Determine the type of a key.

Source

pub fn expire<'a, K>(&mut self, key: K, seconds: i64) -> &mut Pipeline
where K: ToRedisArgs,

Set a key’s time to live in seconds.

Source

pub fn expire_at<'a, K>(&mut self, key: K, ts: i64) -> &mut Pipeline
where K: ToRedisArgs,

Set the expiration for a key as a UNIX timestamp.

Source

pub fn pexpire<'a, K>(&mut self, key: K, ms: i64) -> &mut Pipeline
where K: ToRedisArgs,

Set a key’s time to live in milliseconds.

Source

pub fn pexpire_at<'a, K>(&mut self, key: K, ts: i64) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn persist<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Remove the expiration from a key.

Source

pub fn ttl<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the expiration time of a key.

Source

pub fn pttl<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the expiration time of a key in milliseconds.

Source

pub fn get_ex<'a, K>(&mut self, key: K, expire_at: Expiry) -> &mut Pipeline
where K: ToRedisArgs,

Get the value of a key and set expiration

Source

pub fn get_del<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the value of a key and delete it

Source

pub fn rename<'a, K, N>(&mut self, key: K, new_key: N) -> &mut Pipeline
where K: ToRedisArgs, N: ToRedisArgs,

Rename a key.

Source

pub fn rename_nx<'a, K, N>(&mut self, key: K, new_key: N) -> &mut Pipeline
where K: ToRedisArgs, N: ToRedisArgs,

Rename a key, only if the new key does not exist.

Unlink one or more keys.

Source

pub fn append<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Append a value to a key.

Source

pub fn incr<'a, K, V>(&mut self, key: K, delta: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn decr<'a, K, V>(&mut self, key: K, delta: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn setbit<'a, K>( &mut self, key: K, offset: usize, value: bool, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn getbit<'a, K>(&mut self, key: K, offset: usize) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn bitcount<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Count set bits in a string.

Source

pub fn bitcount_range<'a, K>( &mut self, key: K, start: usize, end: usize, ) -> &mut Pipeline
where K: ToRedisArgs,

Count set bits in a string in a range.

Source

pub fn bit_and<'a, D, S>(&mut self, dstkey: D, srckeys: S) -> &mut Pipeline
where D: ToRedisArgs, S: ToRedisArgs,

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

Source

pub fn bit_or<'a, D, S>(&mut self, dstkey: D, srckeys: S) -> &mut Pipeline
where D: ToRedisArgs, S: ToRedisArgs,

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

Source

pub fn bit_xor<'a, D, S>(&mut self, dstkey: D, srckeys: S) -> &mut Pipeline
where D: ToRedisArgs, S: ToRedisArgs,

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

Source

pub fn bit_not<'a, D, S>(&mut self, dstkey: D, srckey: S) -> &mut Pipeline
where D: ToRedisArgs, S: ToRedisArgs,

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

Source

pub fn strlen<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the length of the value stored in a key.

Source

pub fn hget<'a, K, F>(&mut self, key: K, field: F) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs,

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

Source

pub fn hdel<'a, K, F>(&mut self, key: K, field: F) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs,

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

Source

pub fn hset<'a, K, F, V>(&mut self, key: K, field: F, value: V) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

Sets a single field in a hash.

Source

pub fn hset_nx<'a, K, F, V>( &mut self, key: K, field: F, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn hset_multiple<'a, K, F, V>( &mut self, key: K, items: &'a [(F, V)], ) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs, V: ToRedisArgs,

Sets a multiple fields in a hash.

Source

pub fn hincr<'a, K, F, D>( &mut self, key: K, field: F, delta: D, ) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs, D: ToRedisArgs,

Increments a value.

Source

pub fn hexists<'a, K, F>(&mut self, key: K, field: F) -> &mut Pipeline
where K: ToRedisArgs, F: ToRedisArgs,

Checks if a field in a hash exists.

Source

pub fn hkeys<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Gets all the keys in a hash.

Source

pub fn hvals<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Gets all the values in a hash.

Source

pub fn hgetall<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Gets all the fields and values in a hash.

Source

pub fn hlen<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Gets the length of a hash.

Source

pub fn blmove<'a, S, D>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, timeout: f64, ) -> &mut Pipeline
where S: ToRedisArgs, D: ToRedisArgs,

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

Source

pub fn blmpop<'a, K>( &mut self, timeout: f64, numkeys: usize, key: K, dir: Direction, count: usize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn blpop<'a, K>(&mut self, key: K, timeout: f64) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn brpop<'a, K>(&mut self, key: K, timeout: f64) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn brpoplpush<'a, S, D>( &mut self, srckey: S, dstkey: D, timeout: f64, ) -> &mut Pipeline
where S: ToRedisArgs, D: ToRedisArgs,

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

Source

pub fn lindex<'a, K>(&mut self, key: K, index: isize) -> &mut Pipeline
where K: ToRedisArgs,

Get an element from a list by its index.

Source

pub fn linsert_before<'a, K, P, V>( &mut self, key: K, pivot: P, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs,

Insert an element before another element in a list.

Source

pub fn linsert_after<'a, K, P, V>( &mut self, key: K, pivot: P, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, P: ToRedisArgs, V: ToRedisArgs,

Insert an element after another element in a list.

Source

pub fn llen<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Returns the length of the list stored at key.

Source

pub fn lmove<'a, S, D>( &mut self, srckey: S, dstkey: D, src_dir: Direction, dst_dir: Direction, ) -> &mut Pipeline
where S: ToRedisArgs, D: ToRedisArgs,

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

Source

pub fn lmpop<'a, K>( &mut self, numkeys: usize, key: K, dir: Direction, count: usize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn lpop<'a, K>( &mut self, key: K, count: Option<NonZero<usize>>, ) -> &mut Pipeline
where K: ToRedisArgs,

Removes and returns the up to count first elements of the list stored at key.

If count is not specified, then defaults to first element.

Source

pub fn lpos<'a, K, V>( &mut self, key: K, value: V, options: LposOptions, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn lpush<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn lpush_exists<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn lrange<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

Returns the specified elements of the list stored at key.

Source

pub fn lrem<'a, K, V>( &mut self, key: K, count: isize, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn ltrim<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn lset<'a, K, V>( &mut self, key: K, index: isize, value: V, ) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

Sets the list element at index to value

Source

pub fn rpop<'a, K>( &mut self, key: K, count: Option<NonZero<usize>>, ) -> &mut Pipeline
where K: ToRedisArgs,

Removes and returns the up to count last elements of the list stored at key

If count is not specified, then defaults to last element.

Source

pub fn rpoplpush<'a, K, D>(&mut self, key: K, dstkey: D) -> &mut Pipeline
where K: ToRedisArgs, D: ToRedisArgs,

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

Source

pub fn rpush<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn rpush_exists<'a, K, V>(&mut self, key: K, value: V) -> &mut Pipeline
where K: ToRedisArgs, V: ToRedisArgs,

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

Source

pub fn sadd<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

Add one or more members to a set.

Source

pub fn scard<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the number of members in a set.

Source

pub fn sdiff<'a, K>(&mut self, keys: K) -> &mut Pipeline
where K: ToRedisArgs,

Subtract multiple sets.

Source

pub fn sdiffstore<'a, D, K>(&mut self, dstkey: D, keys: K) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn sinter<'a, K>(&mut self, keys: K) -> &mut Pipeline
where K: ToRedisArgs,

Intersect multiple sets.

Source

pub fn sinterstore<'a, D, K>(&mut self, dstkey: D, keys: K) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn sismember<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn smismember<'a, K, M>(&mut self, key: K, members: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

Determine if given values are members of a set.

Source

pub fn smembers<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get all the members in a set.

Source

pub fn smove<'a, S, D, M>( &mut self, srckey: S, dstkey: D, member: M, ) -> &mut Pipeline
where S: ToRedisArgs, D: ToRedisArgs, M: ToRedisArgs,

Move a member from one set to another.

Source

pub fn spop<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Remove and return a random member from a set.

Source

pub fn srandmember<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get one random member from a set.

Source

pub fn srandmember_multiple<'a, K>( &mut self, key: K, count: usize, ) -> &mut Pipeline
where K: ToRedisArgs,

Get multiple random members from a set.

Source

pub fn srem<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

Remove one or more members from a set.

Source

pub fn sunion<'a, K>(&mut self, keys: K) -> &mut Pipeline
where K: ToRedisArgs,

Add multiple sets.

Source

pub fn sunionstore<'a, D, K>(&mut self, dstkey: D, keys: K) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zadd<'a, K, S, M>( &mut self, key: K, member: M, score: S, ) -> &mut Pipeline
where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zadd_multiple<'a, K, S, M>( &mut self, key: K, items: &'a [(S, M)], ) -> &mut Pipeline
where K: ToRedisArgs, S: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zcard<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Get the number of members in a sorted set.

Source

pub fn zcount<'a, K, M, MM>(&mut self, key: K, min: M, max: MM) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zincr<'a, K, M, D>( &mut self, key: K, member: M, delta: D, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, D: ToRedisArgs,

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

pub fn zinterstore<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zinterstore_min<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zinterstore_max<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zinterstore_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn zinterstore_min_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn zinterstore_max_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn zlexcount<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn bzpopmax<'a, K>(&mut self, key: K, timeout: f64) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zpopmax<'a, K>(&mut self, key: K, count: isize) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn bzpopmin<'a, K>(&mut self, key: K, timeout: f64) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zpopmin<'a, K>(&mut self, key: K, count: isize) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn bzmpop_max<'a, K>( &mut self, timeout: f64, keys: &'a [K], count: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

pub fn zmpop_max<'a, K>(&mut self, keys: &'a [K], count: isize) -> &mut Pipeline
where K: ToRedisArgs,

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

pub fn bzmpop_min<'a, K>( &mut self, timeout: f64, keys: &'a [K], count: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

pub fn zmpop_min<'a, K>(&mut self, keys: &'a [K], count: isize) -> &mut Pipeline
where K: ToRedisArgs,

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

pub fn zrandmember<'a, K>( &mut self, key: K, count: Option<isize>, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrandmember_withscores<'a, K>( &mut self, key: K, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrange<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrange_withscores<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrangebylex<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrangebylex_limit<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrevrangebylex<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrevrangebylex_limit<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrangebyscore<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrangebyscore_withscores<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrangebyscore_limit<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrangebyscore_limit_withscores<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrank<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

Determine the index of a member in a sorted set.

Source

pub fn zrem<'a, K, M>(&mut self, key: K, members: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

Remove one or more members from a sorted set.

Source

pub fn zrembylex<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zremrangebyrank<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrembyscore<'a, K, M, MM>( &mut self, key: K, min: M, max: MM, ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs, MM: ToRedisArgs,

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

Source

pub fn zrevrange<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrevrange_withscores<'a, K>( &mut self, key: K, start: isize, stop: isize, ) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn zrevrangebyscore<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrevrangebyscore_withscores<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrevrangebyscore_limit<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrevrangebyscore_limit_withscores<'a, K, MM, M>( &mut self, key: K, max: MM, min: M, offset: isize, count: isize, ) -> &mut Pipeline
where K: ToRedisArgs, MM: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zrevrank<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zscore<'a, K, M>(&mut self, key: K, member: M) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zscore_multiple<'a, K, M>( &mut self, key: K, members: &'a [M], ) -> &mut Pipeline
where K: ToRedisArgs, M: ToRedisArgs,

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

Source

pub fn zunionstore<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zunionstore_min<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zunionstore_max<'a, D, K>( &mut self, dstkey: D, keys: &'a [K], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs,

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

Source

pub fn zunionstore_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn zunionstore_min_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn zunionstore_max_weights<'a, D, K, W>( &mut self, dstkey: D, keys: &'a [(K, W)], ) -> &mut Pipeline
where D: ToRedisArgs, K: ToRedisArgs, W: ToRedisArgs,

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

pub fn pfadd<'a, K, E>(&mut self, key: K, element: E) -> &mut Pipeline
where K: ToRedisArgs, E: ToRedisArgs,

Adds the specified elements to the specified HyperLogLog.

Source

pub fn pfcount<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn pfmerge<'a, D, S>(&mut self, dstkey: D, srckeys: S) -> &mut Pipeline
where D: ToRedisArgs, S: ToRedisArgs,

Merge N different HyperLogLogs into a single one.

Source

pub fn publish<'a, K, E>(&mut self, channel: K, message: E) -> &mut Pipeline
where K: ToRedisArgs, E: ToRedisArgs,

Posts a message to the given channel.

Source

pub fn object_encoding<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Returns the encoding of a key.

Source

pub fn object_idletime<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

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

Source

pub fn object_freq<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Returns the logarithmic access frequency counter of a key.

Source

pub fn object_refcount<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

Returns the reference count of a key.

Source

pub fn xrevrange_all<'a, K>(&mut self, key: K) -> &mut Pipeline
where K: ToRedisArgs,

This is the reverse version of xrange_all. The same rules apply for start and end here.

XREVRANGE key + -

Trait Implementations§

Source§

impl Clone for Pipeline

Source§

fn clone(&self) -> Pipeline

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for Pipeline

Source§

fn default() -> Pipeline

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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,