Skip to main content

BitStringAsn1Container

Struct BitStringAsn1Container 

Source
pub struct BitStringAsn1Container<Encapsulated>(pub Encapsulated);
Expand description

A BitString encapsulating things.

Same as OctetStringAsn1Container but using a BitString instead.

Useful to perform a full serialization / deserialization in one pass instead of using BitStringAsn1 manually.

Examples

use picky_asn1::wrapper::BitStringAsn1Container;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, PartialEq)]
struct MyType {
    a: u32,
    b: u16,
    c: u16,
}

type MyTypeEncapsulated = BitStringAsn1Container<MyType>;

let encapsulated: MyTypeEncapsulated = MyType {
    a: 83910,
    b: 3839,
    c: 4023,
}.into();

let buffer = [
    0x03, 0x10, 0x00, // bit string part
    0x30, 0x0d, // sequence
    0x02, 0x03, 0x01, 0x47, 0xc6, // integer a
    0x02, 0x02, 0x0e, 0xff, // integer b
    0x02, 0x02, 0x0f, 0xb7, // integer c
];

let encoded = picky_asn1_der::to_vec(&encapsulated).expect("couldn't serialize");
assert_eq!(
    encoded,
    buffer,
);

let decoded: MyTypeEncapsulated = picky_asn1_der::from_bytes(&buffer).expect("couldn't deserialize");
assert_eq!(
    decoded,
    encapsulated,
);

Tuple Fields§

§0: Encapsulated

Trait Implementations§

Source§

impl<Encapsulated> Asn1Type for BitStringAsn1Container<Encapsulated>

Source§

const TAG: Tag = Tag::BIT_STRING

Source§

const NAME: &'static str = "BitStringAsn1Container"

Source§

impl<Encapsulated> Clone for BitStringAsn1Container<Encapsulated>
where Encapsulated: Clone,

Source§

fn clone(&self) -> BitStringAsn1Container<Encapsulated>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Encapsulated> Debug for BitStringAsn1Container<Encapsulated>
where Encapsulated: Debug,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<Encapsulated> Default for BitStringAsn1Container<Encapsulated>
where Encapsulated: Default,

Source§

fn default() -> BitStringAsn1Container<Encapsulated>

Returns the “default value” for a type. Read more
Source§

impl<Encapsulated> Deref for BitStringAsn1Container<Encapsulated>

Source§

type Target = Encapsulated

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<BitStringAsn1Container<Encapsulated> as Deref>::Target

Dereferences the value.
Source§

impl<Encapsulated> DerefMut for BitStringAsn1Container<Encapsulated>

Source§

fn deref_mut( &mut self, ) -> &mut <BitStringAsn1Container<Encapsulated> as Deref>::Target

Mutably dereferences the value.
Source§

impl<'de, Encapsulated> Deserialize<'de> for BitStringAsn1Container<Encapsulated>
where Encapsulated: Deserialize<'de>,

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<BitStringAsn1Container<Encapsulated>, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<Encapsulated> Eq for BitStringAsn1Container<Encapsulated>
where Encapsulated: Eq,

Source§

impl<Encapsulated> From<Encapsulated> for BitStringAsn1Container<Encapsulated>

Source§

fn from(wrapped: Encapsulated) -> BitStringAsn1Container<Encapsulated>

Converts to this type from the input type.
Source§

impl<Encapsulated> Hash for BitStringAsn1Container<Encapsulated>
where Encapsulated: Hash,

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Encapsulated> PartialEq for BitStringAsn1Container<Encapsulated>
where Encapsulated: PartialEq,

Source§

fn eq(&self, other: &BitStringAsn1Container<Encapsulated>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<Encapsulated> PartialEq<Encapsulated> for BitStringAsn1Container<Encapsulated>
where Encapsulated: PartialEq,

Source§

fn eq(&self, other: &Encapsulated) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<Encapsulated> PartialOrd for BitStringAsn1Container<Encapsulated>
where Encapsulated: PartialOrd,

Source§

fn partial_cmp( &self, other: &BitStringAsn1Container<Encapsulated>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<Encapsulated> Serialize for BitStringAsn1Container<Encapsulated>
where Encapsulated: Serialize,

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<Encapsulated> StructuralPartialEq for BitStringAsn1Container<Encapsulated>
where Encapsulated: PartialEq,

Auto Trait Implementations§

§

impl<Encapsulated> Freeze for BitStringAsn1Container<Encapsulated>
where Encapsulated: Freeze,

§

impl<Encapsulated> RefUnwindSafe for BitStringAsn1Container<Encapsulated>
where Encapsulated: RefUnwindSafe,

§

impl<Encapsulated> Send for BitStringAsn1Container<Encapsulated>
where Encapsulated: Send,

§

impl<Encapsulated> Sync for BitStringAsn1Container<Encapsulated>
where Encapsulated: Sync,

§

impl<Encapsulated> Unpin for BitStringAsn1Container<Encapsulated>
where Encapsulated: Unpin,

§

impl<Encapsulated> UnsafeUnpin for BitStringAsn1Container<Encapsulated>
where Encapsulated: UnsafeUnpin,

§

impl<Encapsulated> UnwindSafe for BitStringAsn1Container<Encapsulated>
where Encapsulated: UnwindSafe,

Blanket Implementations§

Source§

impl<T, A, P> Access<T> for P
where A: Access<T> + ?Sized, P: Deref<Target = A>,

Source§

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more
Source§

fn load(&self) -> <P as Access<T>>::Guard

The loading method. Read more
Source§

impl<Source> AccessAs for Source

Source§

fn ref_as<T>(&self) -> <Source as IGuardRef<T>>::Guard<'_>
where Source: IGuardRef<T>, T: ?Sized,

Provides immutable access to a type as if it were its ABI-unstable equivalent.
Source§

fn mut_as<T>(&mut self) -> <Source as IGuardMut<T>>::GuardMut<'_>
where Source: IGuardMut<T>, T: ?Sized,

Provides mutable access to a type as if it were its ABI-unstable equivalent.
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> AsNode<T> for T

Source§

fn as_node(&self) -> &T

Source§

impl<T> AsNodeMut<T> for T

Source§

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

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> Chain<T> for T

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> Commands for T
where T: ConnectionLike,

Source§

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

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>

Get values of keys
Source§

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

Gets all keys matching pattern
Source§

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

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>

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>

👎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>

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>

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>

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>

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>

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>

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>

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>

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>

Delete one or more keys.
Source§

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

Determine if a key exists.
Source§

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

Determine the type of a key.
Source§

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

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>

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>

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>

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

fn expire_time<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

Get the time to live for a key in seconds.
Source§

fn pexpire_time<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

Get the time to live for a key in milliseconds.
Source§

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

Remove the expiration from a key.
Source§

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

Get the expiration time of a key.
Source§

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

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>

Get the value of a key and set expiration
Source§

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

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>

Rename a key.
Source§

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

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>

Append a value to a key.
Source§

fn incr<'a, K, V, RV>(&mut self, key: K, delta: V) -> Result<RV, RedisError>

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>

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>

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>

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>

Count set bits in a string.
Source§

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

Increments a value.
Source§

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

Checks if a field in a hash exists.
Source§

fn httl<'a, K, F, RV>(&mut self, key: K, fields: F) -> Result<RV, RedisError>

Get one or more fields TTL in seconds.
Source§

fn hpttl<'a, K, F, RV>(&mut self, key: K, fields: F) -> Result<RV, RedisError>

Get one or more fields TTL in milliseconds.
Source§

fn hexpire<'a, K, F, RV>( &mut self, key: K, seconds: i64, opt: ExpireOption, fields: F, ) -> Result<RV, RedisError>

Set one or more fields time to live in seconds.
Source§

fn hexpire_at<'a, K, F, RV>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> Result<RV, RedisError>

Set the expiration for one or more fields as a UNIX timestamp in milliseconds.
Source§

fn hexpire_time<'a, K, F, RV>( &mut self, key: K, fields: F, ) -> Result<RV, RedisError>

Returns the absolute Unix expiration timestamp in seconds.
Source§

fn hpersist<'a, K, F, RV>( &mut self, key: K, fields: F, ) -> Result<RV, RedisError>

Remove the expiration from a key.
Source§

fn hpexpire<'a, K, F, RV>( &mut self, key: K, milliseconds: i64, opt: ExpireOption, fields: F, ) -> Result<RV, RedisError>

Set one or more fields time to live in milliseconds.
Source§

fn hpexpire_at<'a, K, F, RV>( &mut self, key: K, ts: i64, opt: ExpireOption, fields: F, ) -> Result<RV, RedisError>

Set the expiration for one or more fields as a UNIX timestamp in milliseconds.
Source§

fn hpexpire_time<'a, K, F, RV>( &mut self, key: K, fields: F, ) -> Result<RV, RedisError>

Returns the absolute Unix expiration timestamp in seconds.
Source§

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

Gets all the keys in a hash.
Source§

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

Gets all the values in a hash.
Source§

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

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

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

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>

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>

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>

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>

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>

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>

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>

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>

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

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

Add one or more members to a set.
Source§

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

Get the number of members in a set.
Source§

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

Subtract multiple sets.
Source§

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

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

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

Intersect multiple sets.
Source§

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

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>

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>

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

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

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>

Move a member from one set to another.
Source§

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

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

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

Get one random member from a set.
Source§

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

Get multiple random members from a set.
Source§

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

Remove one or more members from a set.
Source§

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

Add multiple sets.
Source§

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

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>

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>

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>

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>

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>

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: K, ) -> Result<RV, RedisError>

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: K, ) -> Result<RV, RedisError>

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: K, ) -> Result<RV, RedisError>

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>

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>

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>

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>

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>

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>

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>

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>

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: K, count: isize, ) -> Result<RV, RedisError>

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: K, count: isize, ) -> Result<RV, RedisError>

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: K, count: isize, ) -> Result<RV, RedisError>

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: K, count: isize, ) -> Result<RV, RedisError>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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

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: K, ) -> Result<RV, RedisError>

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: K, ) -> Result<RV, RedisError>

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>

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>

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>

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>

Adds the specified elements to the specified HyperLogLog.
Source§

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

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>

Merge N different HyperLogLogs into a single one.
Source§

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

Posts a message to the given channel.
Source§

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

Returns the encoding of a key.
Source§

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

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>

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

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

Returns the reference count of a key.
Source§

fn client_getname<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Returns the name of the current connection as set by CLIENT SETNAME.
Source§

fn client_id<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Returns the ID of the current connection.
Source§

fn client_setname<'a, K, RV>( &mut self, connection_name: K, ) -> Result<RV, RedisError>

Command assigns a name to the current connection.
Source§

fn acl_load<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file.
Source§

fn acl_save<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file.
Source§

fn acl_list<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Shows the currently active ACL rules in the Redis server.
Source§

fn acl_users<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Shows a list of all the usernames of the currently configured users in the Redis ACL system.
Source§

fn acl_getuser<'a, K, RV>(&mut self, username: K) -> Result<RV, RedisError>

Returns all the rules defined for an existing ACL user.
Source§

fn acl_setuser<'a, K, RV>(&mut self, username: K) -> Result<RV, RedisError>

Creates an ACL user without any privilege.
Source§

fn acl_setuser_rules<'a, K, RV>( &mut self, username: K, rules: &'a [Rule], ) -> Result<RV, RedisError>

Creates an ACL user with the specified rules or modify the rules of an existing user.
Source§

fn acl_deluser<'a, K, RV>( &mut self, usernames: &'a [K], ) -> Result<RV, RedisError>

Delete all the specified ACL users and terminate all the connections that are authenticated with such users.
Source§

fn acl_dryrun<'a, K, C, A, RV>( &mut self, username: K, command: C, args: A, ) -> Result<RV, RedisError>

Simulate the execution of a given command by a given user.
Source§

fn acl_cat<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Shows the available ACL categories.
Source§

fn acl_cat_categoryname<'a, K, RV>( &mut self, categoryname: K, ) -> Result<RV, RedisError>

Shows all the Redis commands in the specified category.
Source§

fn acl_genpass<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Generates a 256-bits password starting from /dev/urandom if available.
Source§

fn acl_genpass_bits<'a, RV>(&mut self, bits: isize) -> Result<RV, RedisError>
where RV: FromRedisValue,

Generates a 1-to-1024-bits password starting from /dev/urandom if available.
Source§

fn acl_whoami<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Returns the username the current connection is authenticated with.
Source§

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

Shows a list of recent ACL security events
Source§

fn acl_log_reset<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Clears the ACL log.
Source§

fn acl_help<'a, RV>(&mut self) -> Result<RV, RedisError>
where RV: FromRedisValue,

Returns a helpful text describing the different subcommands.
Source§

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

Adds the specified geospatial items to the specified key. Read more
Source§

fn geo_dist<'a, K, M1, M2, RV>( &mut self, key: K, member1: M1, member2: M2, unit: Unit, ) -> Result<RV, RedisError>

Return the distance between two members in the geospatial index represented by the sorted set. Read more
Source§

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

Return valid Geohash strings representing the position of one or more members of the geospatial index represented by the sorted set at key. Read more
Source§

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

Return the positions of all the specified members of the geospatial index represented by the sorted set at key. Read more
Source§

fn geo_radius<'a, K, RV>( &mut self, key: K, longitude: f64, latitude: f64, radius: f64, unit: Unit, options: RadiusOptions, ) -> Result<RV, RedisError>

Return the members of a sorted set populated with geospatial information using geo_add, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius). Read more
Source§

fn geo_radius_by_member<'a, K, M, RV>( &mut self, key: K, member: M, radius: f64, unit: Unit, options: RadiusOptions, ) -> Result<RV, RedisError>

Retrieve members selected by distance with the center of member. The member itself is always contained in the results.
Source§

fn xack<'a, K, G, I, RV>( &mut self, key: K, group: G, ids: &'a [I], ) -> Result<RV, RedisError>

Ack pending stream messages checked out by a consumer. Read more
Source§

fn xadd<'a, K, ID, F, V, RV>( &mut self, key: K, id: ID, items: &'a [(F, V)], ) -> Result<RV, RedisError>

Add a stream message by key. Use * as the id for the current timestamp. Read more
Source§

fn xadd_map<'a, K, ID, BTM, RV>( &mut self, key: K, id: ID, map: BTM, ) -> Result<RV, RedisError>

BTreeMap variant for adding a stream message by key. Use * as the id for the current timestamp. Read more
Source§

fn xadd_options<'a, K, ID, I, RV>( &mut self, key: K, id: ID, items: I, options: &'a StreamAddOptions, ) -> Result<RV, RedisError>

Add a stream message with options. Read more
Source§

fn xadd_maxlen<'a, K, ID, F, V, RV>( &mut self, key: K, maxlen: StreamMaxlen, id: ID, items: &'a [(F, V)], ) -> Result<RV, RedisError>

Add a stream message while capping the stream at a maxlength. Read more
Source§

fn xadd_maxlen_map<'a, K, ID, BTM, RV>( &mut self, key: K, maxlen: StreamMaxlen, id: ID, map: BTM, ) -> Result<RV, RedisError>

BTreeMap variant for adding a stream message while capping the stream at a maxlength. Read more
Source§

fn xautoclaim_options<'a, K, G, C, MIT, S, RV>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, start: S, options: StreamAutoClaimOptions, ) -> Result<RV, RedisError>

Perform a combined xpending and xclaim flow. Read more
Source§

fn xclaim<'a, K, G, C, MIT, ID, RV>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], ) -> Result<RV, RedisError>

Claim pending, unacked messages, after some period of time, currently checked out by another consumer. Read more
Source§

fn xclaim_options<'a, K, G, C, MIT, ID, RV>( &mut self, key: K, group: G, consumer: C, min_idle_time: MIT, ids: &'a [ID], options: StreamClaimOptions, ) -> Result<RV, RedisError>

This is the optional arguments version for claiming unacked, pending messages currently checked out by another consumer. Read more
Source§

fn xdel<'a, K, ID, RV>( &mut self, key: K, ids: &'a [ID], ) -> Result<RV, RedisError>

Deletes a list of ids for a given stream key. Read more
Source§

fn xgroup_create<'a, K, G, ID, RV>( &mut self, key: K, group: G, id: ID, ) -> Result<RV, RedisError>

This command is used for creating a consumer group. It expects the stream key to already exist. Otherwise, use xgroup_create_mkstream if it doesn’t. The id is the starting message id all consumers should read from. Use $ If you want all consumers to read from the last message added to stream. Read more
Source§

fn xgroup_createconsumer<'a, K, G, C, RV>( &mut self, key: K, group: G, consumer: C, ) -> Result<RV, RedisError>

This creates a consumer explicitly (vs implicit via XREADGROUP) for given stream `key. Read more
Source§

fn xgroup_create_mkstream<'a, K, G, ID, RV>( &mut self, key: K, group: G, id: ID, ) -> Result<RV, RedisError>

This is the alternate version for creating a consumer group which makes the stream if it doesn’t exist. Read more
Source§

fn xgroup_setid<'a, K, G, ID, RV>( &mut self, key: K, group: G, id: ID, ) -> Result<RV, RedisError>

Alter which id you want consumers to begin reading from an existing consumer group. Read more
Source§

fn xgroup_destroy<'a, K, G, RV>( &mut self, key: K, group: G, ) -> Result<RV, RedisError>

Destroy an existing consumer group for a given stream key Read more
Source§

fn xgroup_delconsumer<'a, K, G, C, RV>( &mut self, key: K, group: G, consumer: C, ) -> Result<RV, RedisError>

This deletes a consumer from an existing consumer group for given stream `key. Read more
Source§

fn xinfo_consumers<'a, K, G, RV>( &mut self, key: K, group: G, ) -> Result<RV, RedisError>

This returns all info details about which consumers have read messages for given consumer group. Take note of the StreamInfoConsumersReply return type. Read more
Source§

fn xinfo_groups<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

Returns all consumer groups created for a given stream key. Take note of the StreamInfoGroupsReply return type. Read more
Source§

fn xinfo_stream<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

Returns info about high-level stream details (first & last message id, length, number of groups, etc.) Take note of the StreamInfoStreamReply return type. Read more
Source§

fn xlen<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

Returns the number of messages for a given stream key. Read more
Source§

fn xpending<'a, K, G, RV>(&mut self, key: K, group: G) -> Result<RV, RedisError>

This is a basic version of making XPENDING command calls which only passes a stream key and consumer group and it returns details about which consumers have pending messages that haven’t been acked. Read more
Source§

fn xpending_count<'a, K, G, S, E, C, RV>( &mut self, key: K, group: G, start: S, end: E, count: C, ) -> Result<RV, RedisError>

This XPENDING version returns a list of all messages over the range. You can use this for paginating pending messages (but without the message HashMap). Read more
Source§

fn xpending_consumer_count<'a, K, G, S, E, C, CN, RV>( &mut self, key: K, group: G, start: S, end: E, count: C, consumer: CN, ) -> Result<RV, RedisError>

An alternate version of xpending_count which filters by consumer name. Read more
Source§

fn xrange<'a, K, S, E, RV>( &mut self, key: K, start: S, end: E, ) -> Result<RV, RedisError>

Returns a range of messages in a given stream key. Read more
Source§

fn xrange_all<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

A helper method for automatically returning all messages in a stream by key. Use with caution! Read more
Source§

fn xrange_count<'a, K, S, E, C, RV>( &mut self, key: K, start: S, end: E, count: C, ) -> Result<RV, RedisError>

A method for paginating a stream by key. Read more
Source§

fn xread<'a, K, ID, RV>( &mut self, keys: &'a [K], ids: &'a [ID], ) -> Result<RV, RedisError>

Read a list of ids for each stream key. This is the basic form of reading streams. For more advanced control, like blocking, limiting, or reading by consumer group, see xread_options. Read more
Source§

fn xread_options<'a, K, ID, RV>( &mut self, keys: &'a [K], ids: &'a [ID], options: &'a StreamReadOptions, ) -> Result<RV, RedisError>

This method handles setting optional arguments for XREAD or XREADGROUP Redis commands. Read more
Source§

fn xrevrange<'a, K, E, S, RV>( &mut self, key: K, end: E, start: S, ) -> Result<RV, RedisError>

This is the reverse version of xrange. The same rules apply for start and end here. Read more
Source§

fn xrevrange_all<'a, K, RV>(&mut self, key: K) -> Result<RV, RedisError>

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

fn xrevrange_count<'a, K, E, S, C, RV>( &mut self, key: K, end: E, start: S, count: C, ) -> Result<RV, RedisError>

This is the reverse version of xrange_count. The same rules apply for start and end here. Read more
Source§

fn xtrim<'a, K, RV>( &mut self, key: K, maxlen: StreamMaxlen, ) -> Result<RV, RedisError>

Trim a stream key to a MAXLEN count. Read more
Source§

fn xtrim_options<'a, K, RV>( &mut self, key: K, options: &'a StreamTrimOptions, ) -> Result<RV, RedisError>

Trim a stream key with full options Read more
Source§

fn invoke_script<'a, RV>( &mut self, invocation: &'a ScriptInvocation<'a>, ) -> Result<RV, RedisError>
where RV: FromRedisValue,

Adds a prepared script command to the pipeline. Read more
Source§

fn scan<RV>(&mut self) -> Result<Iter<'_, RV>, RedisError>
where RV: FromRedisValue,

Incrementally iterate the keys space.
Source§

fn scan_options<RV>( &mut self, opts: ScanOptions, ) -> Result<Iter<'_, RV>, RedisError>
where RV: FromRedisValue,

Incrementally iterate the keys space with options.
Source§

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

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

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

Incrementally iterate hash fields and associated values.
Source§

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

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>

Incrementally iterate set elements.
Source§

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

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

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

Incrementally iterate sorted set elements.
Source§

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

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

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T> ⓘ
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T> ⓘ

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T> ⓘ

Applies the Compat adapter by mutable reference. Read more
Source§

impl<C, T> ConnectionLike for T
where C: ConnectionLike, T: DerefMut<Target = C>,

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 req_packed_commands( &mut self, cmd: &[u8], offset: usize, count: usize, ) -> Result<Vec<Value>, RedisError>

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§

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 supports_pipelining(&self) -> bool

Source§

fn check_connection(&mut self) -> bool

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

fn is_open(&self) -> bool

Returns the connection status. Read more
Source§

impl<T> Container<T> for T
where T: Clone,

Source§

type Iter = Once<T>

An iterator over the items within this container, by value.
Source§

fn get_iter(&self) -> <T as Container<T>>::Iter

Iterate over the elements of the container (using internal iteration because GATs are unstable).
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<Choices> CoproductSubsetter<CNil, HNil> for Choices

Source§

type Remainder = Choices

Source§

fn subset( self, ) -> Result<CNil, <Choices as CoproductSubsetter<CNil, HNil>>::Remainder>

Extract a subset of the possible types in a coproduct (or get the remaining possibilities) Read more
Source§

impl<R> CryptoRng for R
where R: TryCryptoRng<Error = !> + ?Sized,

Source§

impl<T> CryptoRng for T
where T: DerefMut, <T as Deref>::Target: CryptoRng,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T, A> DynAccess<T> for A
where A: Access<T>, <A as Access<T>>::Guard: 'static,

Source§

fn load(&self) -> DynGuard<T>

The equivalent of Access::load.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

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

Source§

impl<E> Executor for E
where E: Deref, <E as Deref>::Target: Sized + Executor,

Source§

type Task<T: Send + 'static> = <<E as Deref>::Target as Executor>::Task<T>

The type representing the tasks the are returned when spawning a Future on the executor
Source§

fn block_on<T, F>(&self, f: F) -> T
where F: Future<Output = T>,

Block on a future until completion
Source§

fn spawn<T, F>(&self, f: F) -> Task<<E as Executor>::Task<T>> ⓘ
where T: Send + 'static, F: Future<Output = T> + Send + 'static,

Spawn a future and return a handle to track its completion.
Source§

fn spawn_blocking<T, F>(&self, f: F) -> Task<<E as Executor>::Task<T>> ⓘ
where T: Send + 'static, F: FnOnce() -> T + Send + 'static,

Convert a blocking task into a future, spawning it on a decicated thread pool
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T, As> IGuardMut<As> for T
where T: Into<As>, As: Into<T>,

Source§

type GuardMut<'a> = MutAs<'a, T, As> where T: 'a

The type of the guard which will clean up the temporary after applying its changes to the original.
Source§

fn guard_mut_inner(&mut self) -> <T as IGuardMut<As>>::GuardMut<'_>

Construct the temporary and guard it through a mutable reference.
Source§

impl<T, As> IGuardRef<As> for T
where T: Into<As>, As: Into<T>,

Source§

type Guard<'a> = RefAs<'a, T, As> where T: 'a

The type of the guard which will clean up the temporary.
Source§

fn guard_ref_inner(&self) -> <T as IGuardRef<As>>::Guard<'_>

Construct the temporary and guard it through an immutable reference.
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Includes<End> for T

Source§

type Output = End

The result
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> 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> IntoAnyArc for T
where T: Send + Sync + 'static,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Upcast to Arc<dyn Any>.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T, U, I> LiftInto<U, I> for T
where U: LiftFrom<T, I>,

Source§

fn lift_into(self) -> U

Performs the indexed conversion.
Source§

impl<T> OrderedContainer<T> for T
where T: Clone,

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> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,

Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R> RandomGenerator for R
where R: RngCore + ?Sized,

Source§

fn try_next_u32(&mut self) -> Result<u32, SecretKeyBuilderError>

returns a random u32

Source§

fn try_fill_bytes( &mut self, buf: &mut [u8], ) -> Result<(), SecretKeyBuilderError>

fills a byte buffer with random

Source§

impl<R> Reactor for R
where R: Deref, <R as Deref>::Target: Sized + Reactor,

Source§

type TcpStream = <<R as Deref>::Target as Reactor>::TcpStream

The type representing a TCP stream (after tcp_connect) for this reactor
Source§

type Sleep = <<R as Deref>::Target as Reactor>::Sleep

The type representing a Sleep for this reactor
Source§

fn register<H>( &self, socket: H, ) -> Result<impl AsyncRead + AsyncWrite + Send + Unpin + 'static, Error>
where H: Read + Write + AsSysFd + Send + 'static,

Register a synchronous handle, returning an asynchronous one
Source§

fn sleep(&self, dur: Duration) -> <R as Reactor>::Sleep

Sleep for the given duration
Source§

fn interval( &self, dur: Duration, ) -> impl Stream<Item = Instant> + Send + 'static

Stream that yields at every given interval
Source§

fn tcp_connect_addr( &self, addr: SocketAddr, ) -> impl Future<Output = Result<<R as Reactor>::TcpStream, Error>> + Send + 'static

Create a TcpStream by connecting to a remote host
Source§

fn tcp_connect<A>( &self, addrs: A, ) -> impl Future<Output = Result<Self::TcpStream, Error>> + Send
where A: AsyncToSocketAddrs + Send, Self: Sized + Sync,

Create a TcpStream by connecting to a remote host
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<R> Rng for R
where R: TryRng<Error = !> + ?Sized,

Source§

fn next_u32(&mut self) -> u32

Return the next random u32.
Source§

fn next_u64(&mut self) -> u64

Return the next random u64.
Source§

fn fill_bytes(&mut self, dst: &mut [u8])

Fill dest with random data. Read more
Source§

impl<R> Rng for R
where R: RngCore + ?Sized,

Source§

fn random<T>(&mut self) -> T

Return a random value via the StandardUniform distribution. Read more
Source§

fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ

Return an iterator over random variates Read more
Source§

fn random_range<T, R>(&mut self, range: R) -> T
where T: SampleUniform, R: SampleRange<T>,

Generate a random value in the given range. Read more
Source§

fn random_bool(&mut self, p: f64) -> bool

Return a bool with a probability p of being true. Read more
Source§

fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool

Return a bool with a probability of numerator/denominator of being true. Read more
Source§

fn sample<T, D>(&mut self, distr: D) -> T
where D: Distribution<T>,

Sample a new value, using the given distribution. Read more
Source§

fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T> ⓘ
where D: Distribution<T>, Self: Sized,

Create an iterator that generates values using the given distribution. Read more
Source§

fn fill<T>(&mut self, dest: &mut T)
where T: Fill + ?Sized,

Fill any type implementing Fill with random data Read more
Source§

fn gen<T>(&mut self) -> T

👎Deprecated since 0.9.0:

Renamed to random to avoid conflict with the new gen keyword in Rust 2024.

Alias for Rng::random.
Source§

fn gen_range<T, R>(&mut self, range: R) -> T
where T: SampleUniform, R: SampleRange<T>,

👎Deprecated since 0.9.0:

Renamed to random_range

Source§

fn gen_bool(&mut self, p: f64) -> bool

👎Deprecated since 0.9.0:

Renamed to random_bool

Alias for Rng::random_bool.
Source§

fn gen_ratio(&mut self, numerator: u32, denominator: u32) -> bool

👎Deprecated since 0.9.0:

Renamed to random_ratio

Source§

impl<R> RngCore for R
where R: Rng,

Source§

impl<T> RngCore for T
where T: DerefMut, <T as Deref>::Target: RngCore,

Source§

fn next_u32(&mut self) -> u32

Return the next random u32. Read more
Source§

fn next_u64(&mut self) -> u64

Return the next random u64. Read more
Source§

fn fill_bytes(&mut self, dst: &mut [u8])

Fill dest with random data. Read more
Source§

impl<R> RngExt for R
where R: Rng + ?Sized,

Source§

fn random<T>(&mut self) -> T

Return a random value via the StandardUniform distribution. Read more
Source§

fn random_iter<T>(self) -> Iter<StandardUniform, Self, T> ⓘ

Return an iterator over random variates Read more
Source§

fn random_range<T, R>(&mut self, range: R) -> T
where T: SampleUniform, R: SampleRange<T>,

Generate a random value in the given range. Read more
Source§

fn random_bool(&mut self, p: f64) -> bool

Return a bool with a probability p of being true. Read more
Source§

fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool

Return a bool with a probability of numerator/denominator of being true. Read more
Source§

fn sample<T, D>(&mut self, distr: D) -> T
where D: Distribution<T>,

Sample a new value, using the given distribution. Read more
Source§

fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T> ⓘ
where D: Distribution<T>, Self: Sized,

Create an iterator that generates values using the given distribution. Read more
Source§

fn fill<T>(&mut self, dest: &mut [T])
where T: Fill,

Fill any type implementing Fill with random data Read more
Source§

impl<T> RngExt for T
where T: Rng,

Source§

fn gen_range_checked<T, R>(&mut self, range: R) -> Option<T>
where T: SampleUniform, R: SampleRange<T>,

Generate a random value in the given range. Read more
Source§

fn gen_range_infallible<T>(&mut self, range: RangeToInclusive<T>) -> T

Generate a random value in the given upper-bounded-only range. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Source> Sculptor<HNil, HNil> for Source

Source§

type Remainder = Source

Source§

fn sculpt(self) -> (HNil, <Source as Sculptor<HNil, HNil>>::Remainder)

Consumes the current HList and returns an HList with the requested shape. Read more
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<R> TryCryptoRng for R
where R: DerefMut, <R as Deref>::Target: TryCryptoRng,

Source§

impl<R> TryCryptoRng for R
where R: CryptoRng + ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.
Source§

impl<R> TryRng for R
where R: DerefMut, <R as Deref>::Target: TryRng,

Source§

type Error = <<R as Deref>::Target as TryRng>::Error

The type returned in the event of a RNG error. Read more
Source§

fn try_next_u32(&mut self) -> Result<u32, <R as TryRng>::Error>

Return the next random u32.
Source§

fn try_next_u64(&mut self) -> Result<u64, <R as TryRng>::Error>

Return the next random u64.
Source§

fn try_fill_bytes(&mut self, dst: &mut [u8]) -> Result<(), <R as TryRng>::Error>

Fill dst entirely with random data.
Source§

impl<R> TryRngCore for R
where R: TryRng,

Source§

type Error = <R as TryRng>::Error

👎Deprecated since 0.10.0:

use TryRng instead

Error type.
Source§

impl<R> TryRngCore for R
where R: RngCore + ?Sized,

Source§

type Error = !

The type returned in the event of a RNG error.
Source§

fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>

Return the next random u32.
Source§

fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>

Return the next random u64.
Source§

fn try_fill_bytes( &mut self, dst: &mut [u8], ) -> Result<(), <R as TryRngCore>::Error>

Fill dest entirely with random data.
Source§

fn unwrap_err(self) -> UnwrapErr<Self>
where Self: Sized,

Wrap RNG with the UnwrapErr wrapper.
Source§

fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>

Wrap RNG with the UnwrapMut wrapper.
Source§

fn read_adapter(&mut self) -> RngReadAdapter<'_, Self> ⓘ
where Self: Sized,

Convert an RngCore to a RngReadAdapter.
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> 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