Struct quick_protobuf_codec::Codec

source ·
pub struct Codec<In, Out = In> { /* private fields */ }
Expand description

Codec implements Encoder and Decoder, uses unsigned_varint to prefix messages with their length and uses quick_protobuf and a provided struct implementing MessageRead and MessageWrite to do the encoding.

Implementations§

source§

impl<In, Out> Codec<In, Out>

source

pub fn new(max_message_len_bytes: usize) -> Self

Create new Codec.

Parameter max_message_len_bytes determines the maximum length of the Protobuf message. The limit does not include the bytes needed for the unsigned_varint.

Trait Implementations§

source§

impl<In, Out> Decoder for Codec<In, Out>
where Out: for<'a> MessageRead<'a>,

§

type Item = Out

The type of items returned by decode
§

type Error = Error

The type of decoding errors.
source§

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

Decode an item from the src BytesMut into an item
source§

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

Called when the input stream reaches EOF, signaling a last attempt to decode Read more
source§

impl<In: MessageWrite, Out> Encoder for Codec<In, Out>

§

type Item = In

The type of items consumed by encode
§

type Error = Error

The type of encoding errors.
source§

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

Encodes an item into the BytesMut provided by dst.

Auto Trait Implementations§

§

impl<In, Out> Freeze for Codec<In, Out>

§

impl<In, Out> RefUnwindSafe for Codec<In, Out>
where In: RefUnwindSafe, Out: RefUnwindSafe,

§

impl<In, Out> Send for Codec<In, Out>
where In: Send, Out: Send,

§

impl<In, Out> Sync for Codec<In, Out>
where In: Sync, Out: Sync,

§

impl<In, Out> Unpin for Codec<In, Out>
where In: Unpin, Out: Unpin,

§

impl<In, Out> UnwindSafe for Codec<In, Out>
where In: UnwindSafe, Out: UnwindSafe,

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

§

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

§

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.