Struct Conn

pub struct Conn {
    pub context: Option<Box<dyn Any>>,
    /* private fields */
}

A client connection.

Fields

context: Option<Box<dyn Any>>

A custom user-defined context.

Implementations

impl Conn

pub fn id(&self) -> u64

A distinct identifier for the connection.

pub fn addr(&self) -> &SocketAddr

The connection socket address.

pub fn next_command(&mut self) -> Option<Vec<Vec<u8>>>

Read the next command in the pipeline, if any.

This method is not typically needed, but it can be used for reading additional incoming commands that may be present. Which, may come in handy for specialized stuff like batching operations or for optimizing a locking strategy.

pub fn write_string(&mut self, msg: &str)

Write a RESP Simple String to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-simple-strings

pub fn write_null(&mut self)

Write a RESP Null Bulk String to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-bulk-strings

pub fn write_error(&mut self, msg: &str)

Write a RESP Error to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-errors

pub fn write_integer(&mut self, x: i64)

Write a RESP Integer to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-errors

pub fn write_array(&mut self, count: usize)

Write a RESP Array to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-arrays

pub fn write_bulk(&mut self, msg: &[u8])

Write a RESP Bulk String to client connection.

https://redis.io/docs/reference/protocol-spec/#resp-simple-strings

pub fn write_raw(&mut self, raw: &[u8])

Write raw bytes to the client connection.

pub fn close(&mut self)

Close the client connection.

pub fn shutdown(&mut self)

Shutdown the server that was started by Server::serve.

This operation will gracefully shutdown the server by closing the all client connections, stopping the server listener, and waiting for the server resources to free.

pub fn cross_close(&mut self, id: u64)

Close a client connection that is not this one.

The identifier is for a client connection that was connection to the same server as self. This operation can safely be called on the same identifier multiple time.