Struct Resp2

pub struct Resp2 { /* private fields */ }

Available on crate features codec and resp2 only.

A framed RESP2 codec.

use futures::{SinkExt, StreamExt};
use redis_protocol::{
  codec::{resp2_encode_command, Resp2},
  resp2::types::{BytesFrame, Resp2Frame},
};
use tokio::net::TcpStream;
use tokio_util::codec::Framed;

async fn example() {
  let socket = TcpStream::connect("127.0.0.1:6379").await.unwrap();
  let mut framed = Framed::new(socket, Resp2::default());

  let auth = resp2_encode_command("AUTH foo bar");
  let get_foo = resp2_encode_command("GET foo");

  let _ = framed.send(auth).await.unwrap();
  let response = framed.next().await.unwrap().unwrap();
  assert_eq!(response.as_str().unwrap(), "OK");

  let _ = framed.send(get_foo).await.unwrap();
  let response = framed.next().await.unwrap().unwrap();
  assert_eq!(response, BytesFrame::Null);
}

Implementations

impl Resp2

pub fn new(int_as_bulkstring: bool) -> Resp2

Create a new codec with the provided flag describing whether the encoder logic should send integers as blob strings.

Trait Implementations

impl Clone for Resp2

fn clone(&self) -> Resp2

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Resp2

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

Formats the value using the given formatter.

impl Decoder for Resp2

type Error = RedisProtocolError

The type of unrecoverable frame decoding errors.

type Item = BytesFrame

The type of decoded frames.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for Resp2

fn default() -> Resp2

Returns the “default value” for a type.

impl Encoder<BorrowedFrame<'_>> for Resp2

type Error = RedisProtocolError

The type of encoding errors.

fn encode( &mut self, item: BorrowedFrame<'_>, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl Encoder<BytesFrame> for Resp2

type Error = RedisProtocolError

The type of encoding errors.

fn encode( &mut self, item: Resp2Frame, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.