embedded_redis::network

Struct Client

Source 
pub struct Client<'a, N: TcpClientStack, C: Clock, P: Protocol>
where
    HelloCommand: Command<<P as Protocol>::FrameType>,
{ /* private fields */ }
Expand description

Client to execute Redis commands

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

Implementations§

Source§

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

Source

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

Source§

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

Source

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

Source§

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

Source

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

Source§

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

Source

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

Source§

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

Source

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

Source§

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

Source

pub fn ping(&'a self) -> Result<Future<'a, N, C, P, PingCommand>, CommandErrors>
where <P as Protocol>::FrameType: ToStringOption + From<CommandBuilder>,

Shorthand for PingCommand

Source§

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

Source

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

Source§

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

Source

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

Source§

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

Source

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

Sends the given command non-blocking

Source

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

Source

pub fn close(&self)

Waiting on any dropped futures to leave a clean state

Source§

impl<N: TcpClientStack, C: Clock> Client<'_, N, C, Resp3>

Source

pub fn get_hello_response(&self) -> &HelloResponse

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

Trait Implementations§

Source§

impl<N: TcpClientStack, C: Clock, P: Protocol> Debug for Client<'_, N, C, P>
where HelloCommand: Command<<P as Protocol>::FrameType>,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, N, C, P> !Freeze for Client<'a, N, C, P>

§

impl<'a, N, C, P> !RefUnwindSafe for Client<'a, N, C, P>

§

impl<'a, N, C, P> !Send for Client<'a, N, C, P>

§

impl<'a, N, C, P> !Sync for Client<'a, N, C, P>

§

impl<'a, N, C, P> Unpin for Client<'a, N, C, P>
where P: Unpin, <P as Protocol>::FrameType: Unpin,

§

impl<'a, N, C, P> !UnwindSafe for Client<'a, N, C, P>

Blanket Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::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(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.