Struct asynchronous_codec::JsonCodec

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

A codec for JSON encoding and decoding using serde_json Enc is the type to encode, Dec is the type to decode

use serde::{Serialize, Deserialize};
use asynchronous_codec::{JsonCodec, Framed};

#[derive(Serialize, Deserialize)]
struct Something {
    pub data: u16,
}

async move {
    // let stream = ...
    let codec = JsonCodec::<Something, Something>::new();
    let mut framed = Framed::new(stream, codec);

    while let Some(s) = framed.try_next().await.unwrap() {
        println!("{:?}", s.data);
    }
};

Implementations

impl<Enc, Dec> JsonCodec<Enc, Dec> where
    Dec: Deserialize<'de> + 'static,
    Enc: Serialize + 'static, 

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

Creates a new JsonCodec with the associated types

Trait Implementations

impl<Enc, Dec> Clone for JsonCodec<Enc, Dec> where
    Dec: Deserialize<'de> + 'static,
    Enc: Serialize + 'static, 

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

Clone creates a new instance of the JsonCodec

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<Enc, Dec> Decoder for JsonCodec<Enc, Dec> where
    Dec: Deserialize<'de> + 'static,
    Enc: Serialize + 'static, 

Decoder impl parses json objects from bytes

type Item = Dec

The type of items returned by decode

type Error = JsonCodecError

The type of decoding errors.

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

Decode an item from the src BytesMut into an item

pub 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

impl<Enc, Dec> Default for JsonCodec<Enc, Dec> where
    Dec: Deserialize<'de> + 'static,
    Enc: Serialize + 'static, 

pub fn default() -> Self

Returns the "default value" for a type.

impl<Enc, Dec> Encoder for JsonCodec<Enc, Dec> where
    Dec: Deserialize<'de> + 'static,
    Enc: Serialize + 'static, 

Encoder impl encodes object streams to bytes

type Item = Enc

The type of items consumed by encode

type Error = JsonCodecError

The type of encoding errors.

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

Encodes an item into the BytesMut provided by dst.

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

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &JsonCodec<Enc, Dec>) -> bool

This method tests for !=.

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