Struct Connection 

pub struct Connection { /* private fields */ }

Represents a stateful redis TCP connection.

Implementations

impl Connection

A connection is an object that represents a single redis connection. It provides basic support for sending encoded commands into a redis connection and to read a response from it. It’s bound to a single database and can only be created from the client.

You generally do not much with this object other than passing it to Cmd objects.

pub fn send_packed_command(&mut self, cmd: &[u8]) -> RedisResult<()>

Sends an already encoded (packed) command into the TCP socket and does not read a response. This is useful for commands like MONITOR which yield multiple items. This needs to be used with care because it changes the state of the connection.

pub fn recv_response(&mut self) -> RedisResult<Value>

Fetches a single response from the connection. This is useful if used in combination with send_packed_command.

pub fn set_write_timeout(&self, dur: Option<Duration>) -> RedisResult<()>

Sets the write timeout for the connection.

If the provided value is None, then send_packed_command call will block indefinitely. It is an error to pass the zero Duration to this method.

pub fn set_read_timeout(&self, dur: Option<Duration>) -> RedisResult<()>

Sets the read timeout for the connection.

If the provided value is None, then recv_response call will block indefinitely. It is an error to pass the zero Duration to this method.

pub fn as_pubsub(&mut self) -> PubSub<'_>

Creates a PubSub instance for this connection.

pub fn set_push_sender(&mut self, sender: Sender<PushInfo>)

Sets sender channel for push values.

pub fn subscribe_resp3<T: ToRedisArgs>(&mut self, channel: T) -> RedisResult<()>

Subscribes to a new channel(s).

This only works if the connection was configured with ProtocolVersion::RESP3 and Self::set_push_sender.

pub fn psubscribe_resp3<T: ToRedisArgs>( &mut self, pchannel: T, ) -> RedisResult<()>

Subscribes to new channel(s) with pattern(s).

This only works if the connection was configured with ProtocolVersion::RESP3 and Self::set_push_sender.

pub fn unsubscribe_resp3<T: ToRedisArgs>( &mut self, channel: T, ) -> RedisResult<()>

Unsubscribes from a channel(s).

This only works if the connection was configured with ProtocolVersion::RESP3 and Self::set_push_sender.

pub fn punsubscribe_resp3<T: ToRedisArgs>( &mut self, pchannel: T, ) -> RedisResult<()>

Unsubscribes from channel pattern(s).

This only works if the connection was configured with ProtocolVersion::RESP3 and Self::set_push_sender.

Trait Implementations

impl ConnectionLike for Connection

fn req_command(&mut self, cmd: &Cmd) -> RedisResult<Value>

Sends a Cmd into the TCP socket and reads a single response from it.

fn req_packed_command(&mut self, cmd: &[u8]) -> RedisResult<Value>

Sends an already encoded (packed) command into the TCP socket and reads the single response from it.

fn get_db(&self) -> i64

Returns the database this connection is bound to. Note that this information might be unreliable because it’s initially cached and also might be incorrect if the connection like object is not actually connected.

fn check_connection(&mut self) -> bool

Check that all connections it has are available (PING internally).

fn is_open(&self) -> bool

Returns the connection status.

impl PubSubCommands for Connection

fn subscribe<C, F, U>(&mut self, channels: C, func: F) -> RedisResult<U>

where F: FnMut(Msg) -> ControlFlow<U>, C: ToRedisArgs,

Subscribe to a list of channels using SUBSCRIBE and run the provided closure for each message received.

fn psubscribe<P, F, U>(&mut self, patterns: P, func: F) -> RedisResult<U>

where F: FnMut(Msg) -> ControlFlow<U>, P: ToRedisArgs,

Subscribe to a list of channels using PSUBSCRIBE and run the provided closure for each message received.