Struct asynchronous_codec::CborCodec

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

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

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

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

async move {
    // let stream = ...
    let codec = CborCodec::<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> CborCodec<Enc, Dec>where
    for<'de> Dec: Deserialize<'de> + 'static,
    for<'de> Enc: Serialize + 'static,

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

Creates a new CborCodec with the associated types

Trait Implementations

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

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

Clone creates a new instance of the CborCodec

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

Decoder impl parses cbor objects from bytes

type Item = Dec

The type of items returned by decode

type Error = CborCodecError

The type of decoding errors.

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

Decode an item from the src BytesMut into an item

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 CborCodec<Enc, Dec>where
    for<'de> Dec: Deserialize<'de> + 'static,
    for<'de> Enc: Serialize + 'static,

fn default() -> Self

Returns the “default value” for a type.

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

Encoder impl encodes object streams to bytes

type Item = Enc

The type of items consumed by encode

type Error = CborCodecError

The type of encoding errors.

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<CborCodec<Enc, Dec>> for CborCodec<Enc, Dec>

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

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

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

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

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