Struct GenericCodec

pub struct GenericCodec<T: Serialize + DeserializeOwned> { /* private fields */ }

Codec to pass over any struct that implements Serialize and DeserializeOwned traits.

Examples

use cs_utils::{random_number, random_str, random_bool, futures::GenericCodec};
use futures::{StreamExt, SinkExt};
use serde::{Serialize, Deserialize};
use tokio::{io::duplex, try_join};
use tokio_util::codec::Framed;
 
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
struct TestStruct {
    id: u16,
    name: String,
    is_flag: bool,
}
 
println!("\n🏷️  Generic codec example:");
println!("\n⚠️ Note: the \"async\" feature must be enabled!\n");

let (stream, _) = duplex(4096);

let message = TestStruct {
    id: random_number(0..=u16::MAX),
    name: random_str(8),
    is_flag: random_bool(),
};
 
let framed_stream = Framed::new(
    stream,
    GenericCodec::<TestStruct>::new(),
 );
 
let (mut sink, mut source) = framed_stream.split();
 
// send/receive the framed data using the sink/source
// see "generic_codec" example for more details

Implementations

impl<T: Serialize + DeserializeOwned> GenericCodec<T>

pub fn new() -> Self

Trait Implementations

impl<T: Clone + Serialize + DeserializeOwned> Clone for GenericCodec<T>

fn clone(&self) -> GenericCodec<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Serialize + DeserializeOwned> Debug for GenericCodec<T>

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

Formats the value using the given formatter.

impl<T: Serialize + DeserializeOwned> Decoder for GenericCodec<T>

type Item = T

The type of decoded frames.

type Error = Error

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,

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<T: Serialize + DeserializeOwned> Default for GenericCodec<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Serialize + DeserializeOwned> Encoder<T> for GenericCodec<T>

type Error = Error

The type of encoding errors.

fn encode( &mut self, message: T, dist_buff: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.