Struct JsonCodec

pub struct JsonCodec<Enc, Dec, E> { /* private fields */ }

A codec for JSON encoding and decoding Enc is the type to encode, Dec is the type to decode, E is the error type to be returned for both operations

Implementations

impl<Enc, Dec, E> JsonCodec<Enc, Dec, E>

where for<'de> Dec: Deserialize<'de> + Clone + Send + 'static, for<'de> Enc: Serialize + Clone + Send + 'static, E: From<Error> + From<Error> + 'static,

New builds an empty codec with associated types

pub fn new() -> JsonCodec<Enc, Dec, E>

Creates a new JsonCodec for shipping around raw bytes.

Trait Implementations

impl<Enc, Dec, E> Clone for JsonCodec<Enc, Dec, E>

where for<'de> Dec: Deserialize<'de> + Clone + Send + 'static, for<'de> Enc: Serialize + Clone + Send + 'static, E: From<Error> + From<Error> + 'static,

Clone impl required for use with connections

fn clone(&self) -> JsonCodec<Enc, Dec, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Enc: Debug, Dec: Debug, E: Debug> Debug for JsonCodec<Enc, Dec, E>

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

Formats the value using the given formatter.

impl<Enc, Dec, E> Decoder for JsonCodec<Enc, Dec, E>

where for<'de> Dec: Deserialize<'de> + Clone + Send + 'static, for<'de> Enc: Serialize + Clone + Send + 'static, E: From<Error> + From<Error> + 'static,

Decoder impl parses json objects from bytes

type Item = Dec

The type of decoded frames.

type Error = E

The type of unrecoverable frame decoding errors.

fn decode( &mut self, buf: &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 + Encoder,

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<Enc, Dec, E> Encoder for JsonCodec<Enc, Dec, E>

where for<'de> Dec: Deserialize<'de> + Clone + Send + 'static, for<'de> Enc: Serialize + Clone + Send + 'static, E: From<Error> + From<Error> + 'static,

Encoder impl encodes object streams to bytes

type Item = Enc

The type of items consumed by the Encoder

type Error = E

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl<Enc: PartialEq, Dec: PartialEq, E: PartialEq> PartialEq for JsonCodec<Enc, Dec, E>

fn eq(&self, other: &JsonCodec<Enc, Dec, E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Enc, Dec, E> StructuralPartialEq for JsonCodec<Enc, Dec, E>