redis_driver

Trait SetCommands

Source 
pub trait SetCommands {

Show 17 methods    // Provided methods
    fn sadd<K, M, C>(
        &mut self,
        key: K,
        members: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             M: Into<CommandArg>,
             C: SingleArgOrCollection<M> { ... }
    fn scard<K>(&mut self, key: K) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg> { ... }
    fn sdiff<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             C: SingleArgOrCollection<K>,
             A: FromSingleValueArray<M> { ... }
    fn sdiffstore<D, K, C>(
        &mut self,
        destination: D,
        keys: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             D: Into<CommandArg>,
             K: Into<CommandArg>,
             C: SingleArgOrCollection<K> { ... }
    fn sinter<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             C: SingleArgOrCollection<K>,
             A: FromSingleValueArray<M> { ... }
    fn sintercard<K, C>(
        &mut self,
        keys: C,
        limit: usize,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             C: SingleArgOrCollection<K> { ... }
    fn sinterstore<D, K, C>(
        &mut self,
        destination: D,
        keys: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             D: Into<CommandArg>,
             K: Into<CommandArg>,
             C: SingleArgOrCollection<K> { ... }
    fn sismember<K, M>(
        &mut self,
        key: K,
        member: M,
    ) -> PreparedCommand<'_, Self, bool>
       where Self: Sized,
             K: Into<CommandArg>,
             M: Into<CommandArg> { ... }
    fn smembers<K, M, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             A: FromSingleValueArray<M> { ... }
    fn smismember<K, M, C>(
        &mut self,
        key: K,
        members: C,
    ) -> PreparedCommand<'_, Self, Vec<bool>>
       where Self: Sized,
             K: Into<CommandArg>,
             M: Into<CommandArg>,
             C: SingleArgOrCollection<M> { ... }
    fn smove<S, D, M>(
        &mut self,
        source: S,
        destination: D,
        member: M,
    ) -> PreparedCommand<'_, Self, bool>
       where Self: Sized,
             S: Into<CommandArg>,
             D: Into<CommandArg>,
             M: Into<CommandArg> { ... }
    fn spop<K, M, A>(
        &mut self,
        key: K,
        count: usize,
    ) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             A: FromSingleValueArray<M> { ... }
    fn srandmember<K, M, A>(
        &mut self,
        key: K,
        count: usize,
    ) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             A: FromSingleValueArray<M> { ... }
    fn srem<K, M, C>(
        &mut self,
        key: K,
        members: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             K: Into<CommandArg>,
             M: Into<CommandArg>,
             C: SingleArgOrCollection<M> { ... }
    fn sscan<K, M>(
        &mut self,
        key: K,
        cursor: u64,
        options: SScanOptions,
    ) -> PreparedCommand<'_, Self, (u64, Vec<M>)>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue { ... }
    fn sunion<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
       where Self: Sized,
             K: Into<CommandArg>,
             M: FromValue + Eq + Hash,
             C: SingleArgOrCollection<K>,
             A: FromSingleValueArray<M> { ... }
    fn sunionstore<D, K, C>(
        &mut self,
        destination: D,
        keys: C,
    ) -> PreparedCommand<'_, Self, usize>
       where Self: Sized,
             D: Into<CommandArg>,
             K: Into<CommandArg>,
             C: SingleArgOrCollection<K> { ... }

}
Expand description

A group of Redis commands related to Sets

§See Also

Redis Set Commands

Provided Methods§

Source

fn sadd<K, M, C>( &mut self, key: K, members: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, M: Into<CommandArg>, C: SingleArgOrCollection<M>,

Add the specified members to the set stored at key.

§See Also

https://redis.io/commands/sadd/

Source

fn scard<K>(&mut self, key: K) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>,

Returns the set cardinality (number of elements) of the set stored at key.

§Return

The cardinality (number of elements) of the set, or 0 if key does not exist.

§See Also

https://redis.io/commands/scard/

Source

fn sdiff<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, C: SingleArgOrCollection<K>, A: FromSingleValueArray<M>,

Returns the members of the set resulting from the difference between the first set and all the successive sets.

§Return

A list with members of the resulting set.

§See Also

https://redis.io/commands/sdiff/

Source

fn sdiffstore<D, K, C>( &mut self, destination: D, keys: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, D: Into<CommandArg>, K: Into<CommandArg>, C: SingleArgOrCollection<K>,

This command is equal to sdiff, but instead of returning the resulting set, it is stored in destination.

§Return

The number of elements in the resulting set.

§See Also

https://redis.io/commands/sdiffstore/

Source

fn sinter<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, C: SingleArgOrCollection<K>, A: FromSingleValueArray<M>,

Returns the members of the set resulting from the intersection of all the given sets.

§Return

A list with members of the resulting set.

§See Also

https://redis.io/commands/sinter/

Source

fn sintercard<K, C>( &mut self, keys: C, limit: usize, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, C: SingleArgOrCollection<K>,

This command is similar to sinter, but instead of returning the result set, it returns just the cardinality of the result.

limit: if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality. 0 means unlimited

§Return

A list with members of the resulting set.

§See Also

https://redis.io/commands/sintercard/

Source

fn sinterstore<D, K, C>( &mut self, destination: D, keys: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, D: Into<CommandArg>, K: Into<CommandArg>, C: SingleArgOrCollection<K>,

This command is equal to sinter, but instead of returning the resulting set, it is stored in destination.

§Return

The number of elements in the resulting set.

§See Also

https://redis.io/commands/sinterstore/

Source

fn sismember<K, M>( &mut self, key: K, member: M, ) -> PreparedCommand<'_, Self, bool>
where Self: Sized, K: Into<CommandArg>, M: Into<CommandArg>,

Returns if member is a member of the set stored at key.

§Return
  • true - if the element is a member of the set.
  • false - if the element is not a member of the set, or if key does not exist.
§See Also

https://redis.io/commands/sismember/

Source

fn smembers<K, M, A>(&mut self, key: K) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, A: FromSingleValueArray<M>,

Returns all the members of the set value stored at key.

§See Also

https://redis.io/commands/smembers/

Source

fn smismember<K, M, C>( &mut self, key: K, members: C, ) -> PreparedCommand<'_, Self, Vec<bool>>
where Self: Sized, K: Into<CommandArg>, M: Into<CommandArg>, C: SingleArgOrCollection<M>,

Returns whether each member is a member of the set stored at key.

§Return

list representing the membership of the given elements, in the same order as they are requested.

§See Also

https://redis.io/commands/smismember/

Source

fn smove<S, D, M>( &mut self, source: S, destination: D, member: M, ) -> PreparedCommand<'_, Self, bool>
where Self: Sized, S: Into<CommandArg>, D: Into<CommandArg>, M: Into<CommandArg>,

Move member from the set at source to the set at destination.

§Return
  • true - if the element is moved.
  • false - if the element is not a member of source and no operation was performed.
§See Also

https://redis.io/commands/smove/

Source

fn spop<K, M, A>( &mut self, key: K, count: usize, ) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, A: FromSingleValueArray<M>,

Removes and returns one or more random members from the set value store at key.

§Return

the list of popped elements

§See Also

https://redis.io/commands/spop/

Source

fn srandmember<K, M, A>( &mut self, key: K, count: usize, ) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, A: FromSingleValueArray<M>,

Removes and returns one or more random members from the set value store at key.

§Return

the list of popped elements

§See Also

https://redis.io/commands/srandmember/

Source

fn srem<K, M, C>( &mut self, key: K, members: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, K: Into<CommandArg>, M: Into<CommandArg>, C: SingleArgOrCollection<M>,

Remove the specified members from the set stored at key.

§Return

the number of members that were removed from the set, not including non existing members.

§See Also

https://redis.io/commands/srem/

Source

fn sscan<K, M>( &mut self, key: K, cursor: u64, options: SScanOptions, ) -> PreparedCommand<'_, Self, (u64, Vec<M>)>
where Self: Sized, K: Into<CommandArg>, M: FromValue,

Iterates elements of Sets types.

§Return

a list of Set members.

§See Also

https://redis.io/commands/sscan/

Source

fn sunion<K, M, C, A>(&mut self, keys: C) -> PreparedCommand<'_, Self, A>
where Self: Sized, K: Into<CommandArg>, M: FromValue + Eq + Hash, C: SingleArgOrCollection<K>, A: FromSingleValueArray<M>,

Returns the members of the set resulting from the union of all the given sets.

§Return

A list with members of the resulting set.

§See Also

https://redis.io/commands/sunion/

Source

fn sunionstore<D, K, C>( &mut self, destination: D, keys: C, ) -> PreparedCommand<'_, Self, usize>
where Self: Sized, D: Into<CommandArg>, K: Into<CommandArg>, C: SingleArgOrCollection<K>,

This command is equal to sunion, but instead of returning the resulting set, it is stored in destination.

§Return

The number of elements in the resulting set.

§See Also

https://redis.io/commands/sunionstore/

Implementors§