Trait redis_driver::BitmapCommands

pub trait BitmapCommands {
    fn bitcount<K>(
        &mut self,
        key: K,
        range: BitRange
    ) -> PreparedCommand<'_, Self, usize>
    where
        Self: Sized,
        K: Into<BulkString>,
    { ... }
    fn bitfield<K, C, E, O>(
        &mut self,
        key: K,
        sub_commands: C
    ) -> PreparedCommand<'_, Self, Vec<u64>>
    where
        Self: Sized,
        K: Into<BulkString>,
        E: Into<BulkString>,
        O: Into<BulkString>,
        C: ArgsOrCollection<BitFieldSubCommand<E, O>>,
    { ... }
    fn bitfield_readonly<K, C, E, O>(
        &mut self,
        key: K,
        get_commands: C
    ) -> PreparedCommand<'_, Self, Vec<u64>>
    where
        Self: Sized,
        K: Into<BulkString>,
        E: Into<BulkString>,
        O: Into<BulkString>,
        C: ArgsOrCollection<BitFieldGetSubCommand<E, O>>,
    { ... }
    fn bitop<D, K, KK>(
        &mut self,
        operation: BitOperation,
        dest_key: D,
        keys: KK
    ) -> PreparedCommand<'_, Self, usize>
    where
        Self: Sized,
        D: Into<BulkString>,
        K: Into<BulkString>,
        KK: SingleArgOrCollection<K>,
    { ... }
    fn bitpos<K>(
        &mut self,
        key: K,
        bit: u64,
        range: BitRange
    ) -> PreparedCommand<'_, Self, usize>
    where
        Self: Sized,
        K: Into<BulkString>,
    { ... }
    fn getbit<K>(&mut self, key: K, offset: u64) -> PreparedCommand<'_, Self, u64>
    where
        Self: Sized,
        K: Into<BulkString>,
    { ... }
    fn setbit<K>(
        &mut self,
        key: K,
        offset: u64,
        value: u64
    ) -> PreparedCommand<'_, Self, u64>
    where
        Self: Sized,
        K: Into<BulkString>,
    { ... }
}

A group of Redis commands related to Bitmaps & Bitfields

See Also

Redis Generic Commands

Provided Methods

fn bitcount<K>(
    &mut self,
    key: K,
    range: BitRange
) -> PreparedCommand<'_, Self, usize>where
    Self: Sized,
    K: Into<BulkString>,

Count the number of set bits (population counting) in a string.

Return

The number of bits set to 1.

See Also

https://redis.io/commands/bitcount/

fn bitfield<K, C, E, O>(
    &mut self,
    key: K,
    sub_commands: C
) -> PreparedCommand<'_, Self, Vec<u64>>where
    Self: Sized,
    K: Into<BulkString>,
    E: Into<BulkString>,
    O: Into<BulkString>,
    C: ArgsOrCollection<BitFieldSubCommand<E, O>>,

The command treats a Redis string as an array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset.

Return

A collection with each entry being the corresponding result of the sub command given at the same position. OVERFLOW subcommands don’t count as generating a reply.

See Also

https://redis.io/commands/bitfield/

fn bitfield_readonly<K, C, E, O>(
    &mut self,
    key: K,
    get_commands: C
) -> PreparedCommand<'_, Self, Vec<u64>>where
    Self: Sized,
    K: Into<BulkString>,
    E: Into<BulkString>,
    O: Into<BulkString>,
    C: ArgsOrCollection<BitFieldGetSubCommand<E, O>>,

Read-only variant of the BITFIELD command. It is like the original BITFIELD but only accepts GET subcommand and can safely be used in read-only replicas.

Return

A collection with each entry being the corresponding result of the sub command given at the same position.

See Also

https://redis.io/commands/bitfield_ro/

fn bitop<D, K, KK>(
    &mut self,
    operation: BitOperation,
    dest_key: D,
    keys: KK
) -> PreparedCommand<'_, Self, usize>where
    Self: Sized,
    D: Into<BulkString>,
    K: Into<BulkString>,
    KK: SingleArgOrCollection<K>,

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

Return

The size of the string stored in the destination key, that is equal to the size of the longest input string.

See Also

https://redis.io/commands/bitop/

fn bitpos<K>(
    &mut self,
    key: K,
    bit: u64,
    range: BitRange
) -> PreparedCommand<'_, Self, usize>where
    Self: Sized,
    K: Into<BulkString>,

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

Return

The position of the first bit set to 1 or 0 according to the request.

See Also

https://redis.io/commands/bitpos/

fn getbit<K>(&mut self, key: K, offset: u64) -> PreparedCommand<'_, Self, u64>where
    Self: Sized,
    K: Into<BulkString>,

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

Return

The bit value stored at offset.

See Also

https://redis.io/commands/getbit/

fn setbit<K>(
    &mut self,
    key: K,
    offset: u64,
    value: u64
) -> PreparedCommand<'_, Self, u64>where
    Self: Sized,
    K: Into<BulkString>,

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

Return

The original bit value stored at offset.

See Also

https://redis.io/commands/setbit/

Implementors

impl BitmapCommands for Client

impl BitmapCommands for MultiplexedClient

impl BitmapCommands for Pipeline

impl BitmapCommands for Transaction