Struct Client 

pub struct Client<'a, T: Read + Write, C: Clock, P: Protocol>
where
    HelloCommand: Command<<P as Protocol>::FrameType>,
{ /* private fields */ }

Client to execute Redis commands

The functionality of the client is best explained by a command example.

Implementations

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn bgsave(&self, schedule: bool) -> Result<(), CommandErrors>

where <P as Protocol>::FrameType: From<CommandBuilder>,

Shorthand for BackgroundSaveCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn get<K>(&self, key: K) -> Result<Option<GetResponse>, CommandErrors>

where <P as Protocol>::FrameType: ToStringBytes + IsNullFrame + From<CommandBuilder>, Bytes: From<K>,

Shorthand for GetCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn hget<K, F>( &self, key: K, field: F, ) -> Result<Option<GetResponse>, CommandErrors>

where <P as Protocol>::FrameType: ToStringBytes + IsNullFrame + From<CommandBuilder>, Bytes: From<K> + From<F>,

Shorthand for HashGetCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn hgetall<K>( &self, key: K, ) -> Result<Option<HashResponse>, CommandErrors>

where <P as Protocol>::FrameType: ToBytesMap + From<CommandBuilder>, Bytes: From<K>,

Shorthand for HashGetAllCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn hset<K, F, V>( &self, key: K, field: F, value: V, ) -> Result<i64, CommandErrors>

where Bytes: From<K> + From<F> + From<V>, <P as Protocol>::FrameType: ToInteger + From<CommandBuilder>,

Shorthand for HashSetCommand For setting multiple fields, use HashSetCommand directly instead

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn keys<K>(&self, pattern: K) -> Result<Vec<Bytes>, CommandErrors>

where <P as Protocol>::FrameType: ToBytesVec + From<CommandBuilder>, Bytes: From<K>,

Shorthand for KeysCommand. Returns matching keys, or an empty vector if none match.

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn ping(&self) -> Result<(), CommandErrors>

where <P as Protocol>::FrameType: ToStringOption + From<CommandBuilder>,

Shorthand for PingCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn publish<K, V>( &self, channel: K, message: V, ) -> Result<i64, CommandErrors>

where <P as Protocol>::FrameType: ToInteger + From<CommandBuilder>, Bytes: From<K> + From<V>,

Shorthand for PublishCommand

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn set<K, V>( &self, key: K, value: V, ) -> Result<ConfirmationResponse, CommandErrors>

where <P as Protocol>::FrameType: ToStringBytes + ToStringOption + IsNullFrame + From<CommandBuilder>, Bytes: From<K> + From<V>,

Shorthand for SetCommand For using options of SET command, use SetCommand directly instead

impl<'a, T: Read + Write, C: Clock, P: Protocol> Client<'a, T, C, P>

where AuthCommand: Command<<P as Protocol>::FrameType>, HelloCommand: Command<<P as Protocol>::FrameType>,

pub async fn send<Cmd>( &self, command: Cmd, ) -> Result<Cmd::Response, CommandErrors>

where Cmd: Command<P::FrameType>,

Sends the given command and asynchronously waits for its evaluated response.

pub async fn subscribe<const L: usize>( self, channels: [Bytes; L], ) -> Result<Subscription<'a, T, C, P, L>, Error>

where <P as Protocol>::FrameType: ToPushMessage + From<CommandBuilder>,

Subscribes the given channels and returns a subscription client.

If subscribing fails, drop the client so its connection is closed; the server-side state may be undefined.

pub async fn close(&self)

Waiting on any dropped futures to leave a clean state

impl<T: Read + Write, C: Clock> Client<'_, T, C, Resp3>

pub fn get_hello_response(&self) -> &HelloResponse

Returns the response to HELLO command executed during connection initialization [Client HELLO response]

Trait Implementations

impl<T: Read + Write, C: Clock, P: Protocol> Debug for Client<'_, T, C, P>

where HelloCommand: Command<<P as Protocol>::FrameType>,

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

Formats the value using the given formatter.