Struct Codec 

pub struct Codec<D: StreamDeserializer, S: StreamSerializer, T> { /* private fields */ }

Available on crate feature codec only.

Implements the codec traits of tokio-util.

The codec decodes values of type T with a StreamDeserializer and encodes values with a StreamSerializer (for instance deser_json::StreamDeserializer and deser_json::Serializer). This makes it usable with FramedRead, FramedWrite and Framed:

use futures_util::{SinkExt, StreamExt};
use deser_json::{DeserializerConfig, Serializer, SerializerConfig, StreamDeserializer, Trailing};
use deser_tokio::Codec;
use tokio_util::codec::Framed;

const READ_LINES: DeserializerConfig =
    DeserializerConfig::builder().trailing(Trailing::Newline).build();
const WRITE_LINES: SerializerConfig =
    SerializerConfig::builder().trailing(Trailing::Newline).build();

let (client, server) = tokio::io::duplex(1024);
let codec = || {
    Codec::<_, _, Vec<u32>>::new(
        StreamDeserializer::with_config(READ_LINES),
        Serializer::with_config(WRITE_LINES),
    )
};
let mut client = Framed::new(client, codec());
let mut server = Framed::new(server, codec());
client.send(vec![1, 2]).await.unwrap();
assert_eq!(server.next().await.unwrap().unwrap(), [1, 2]);

The data read by the framed reader is moved into the codec’s buffer, so errors refer to positions in the stream. If the format supports it (see StreamDeserializer::supports_partial), values are deserialized while their input arrives.

Implementations

impl<D: StreamDeserializer, S: StreamSerializer, T> Codec<D, S, T>

pub fn new(deserializer: D, serializer: S) -> Codec<D, S, T>

Creates a codec.

pub fn deserializer(&self) -> &D

Returns the stream deserializer.

pub fn serializer(&self) -> &S

Returns the stream serializer.

pub fn set_context(&mut self, context: Context)

Sets the context the values are deserialized and serialized in.

This replaces the context of the stream deserializer (see StreamDeserializer::context). The values of the context are the defaults of the extension values of the state (see Context).

pub fn context(&self) -> &Context

Returns the context the values are deserialized and serialized in.

Trait Implementations

impl<D: StreamDeserializer, S: StreamSerializer, T: DeserializeOwned> Decoder for Codec<D, S, T>

type Item = T

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof(&mut self, src: &mut BytesMut) -> Result<Option<T>, 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,

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<D: StreamDeserializer, S: StreamSerializer, T, V: Serialize> Encoder<V> for Codec<D, S, T>

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.