Struct embedded_redis::network::Client

pub struct Client<'a, N: TcpClientStack, 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, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn bgsave( &'a self, schedule: bool ) -> Result<Future<'a, N, C, P, BackgroundSaveCommand>, CommandErrors>

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

Shorthand for BackgroundSaveCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn get<K>( &'a self, key: K ) -> Result<Future<'a, N, C, P, GetCommand>, CommandErrors>

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

Shorthand for GetCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn hget<K, F>( &'a self, key: K, field: F ) -> Result<Future<'a, N, C, P, HashGetCommand>, CommandErrors>

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

Shorthand for HashGetCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn hgetall<K>( &'a self, key: K ) -> Result<Future<'a, N, C, P, HashGetAllCommand>, CommandErrors>

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

Shorthand for HashGetAllCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn hset<K, F, V>( &'a self, key: K, field: F, value: V ) -> Result<Future<'a, N, C, P, HashSetCommand<1>>, 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, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn ping(&'a self) -> Result<Future<'a, N, C, P, PingCommand>, CommandErrors>

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

Shorthand for PingCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn publish<K, V>( &'a self, channel: K, message: V ) -> Result<Future<'a, N, C, P, PublishCommand>, CommandErrors>

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

Shorthand for PublishCommand

impl<'a, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn set<K, V>( &'a self, key: K, value: V ) -> Result<Future<'a, N, C, P, SetCommand<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, N: TcpClientStack, C: Clock, P: Protocol> Client<'a, N, C, P>

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

pub fn send<Cmd>( &'a self, command: Cmd ) -> Result<Future<'_, N, C, P, Cmd>, CommandErrors>

where Cmd: Command<P::FrameType>,

Sends the given command non-blocking

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

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

Subscribes the given channels and returns a subscription client.

If the subscriptions fails, it’s recommended to close the connection, as a the state is undefined. A further reuse of the connection could cause subsequent errors

pub fn close(&self)

Waiting on any dropped futures to leave a clean state

impl<'a, N: TcpClientStack, C: Clock> Client<'a, N, 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<'a, N: TcpClientStack, C: Clock, P: Protocol> Debug for Client<'a, N, C, P>

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

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

Formats the value using the given formatter.