Skip to main content

RespCodec

Struct RespCodec 

Source
pub struct RespCodec { /* private fields */ }
Expand description

Tokio-util codec for RESP2/RESP3 framing.

A single instance manages one connection’s protocol state. Call set_version after a successful HELLO 3 handshake to switch to RESP3.

Implementations§

Source§

impl RespCodec

Source

pub fn new(version: Version) -> Self

Source

pub fn resp2() -> Self

Source

pub fn resp3() -> Self

Source

pub fn with_max_frame_bytes(self, limit: usize) -> Self

Source

pub fn set_version(&mut self, version: Version)

Switch protocol version mid-stream (e.g. after HELLO 3 succeeds).

Source

pub fn version(&self) -> Version

Trait Implementations§

Source§

impl Clone for RespCodec

Source§

fn clone(&self) -> RespCodec

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RespCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decoder for RespCodec

Source§

type Item = Value

The type of decoded frames.
Source§

type Error = RespError

The type of unrecoverable frame decoding errors. Read more
Source§

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Value>, RespError>

Attempts to decode a frame from the provided buffer of bytes. Read more
Source§

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. Read more
Source§

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. Read more
Source§

impl Default for RespCodec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Encoder<&Value> for RespCodec

Source§

type Error = RespError

The type of encoding errors. Read more
Source§

fn encode(&mut self, item: &Value, dst: &mut BytesMut) -> Result<(), RespError>

Encodes a frame into the buffer provided. Read more
Source§

impl Encoder<Value> for RespCodec

Source§

type Error = RespError

The type of encoding errors. Read more
Source§

fn encode(&mut self, item: Value, dst: &mut BytesMut) -> Result<(), RespError>

Encodes a frame into the buffer provided. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.