Trait Encode 

pub trait Encode: Sized {
    // Required method
    fn encode<W: Write>(&self, w: W) -> Result<usize, Error>;

    // Provided methods
    fn type_id(&self) -> Option<u32> { ... }
    fn encode_to_vec(&self) -> Result<Vec<u8>, Error>
       where Self: Sealed { ... }
}

A trait that can be encoded into an io::Write stream.

Implementing this trait allows types to be encoded into an io::Write stream, which is useful for writing data to various destinations like files, buffers, and streams.

Examples

use codeq::Encode;

let data = "hello".to_string();
let mut buf = Vec::new();
data.encode(&mut buf).unwrap();
assert_eq!(buf, b"\x00\x00\x00\x05hello");

Required Methods

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

Provided Methods

fn type_id(&self) -> Option<u32>

Returns the leading type id when the encoded form starts with one.

fn encode_to_vec(&self) -> Result<Vec<u8>, Error>

where Self: Sealed,

Encodes the value into a new Vec<u8>.

This method is sealed and cannot be implemented outside of the crate.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Encode for &str

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for ()

fn encode<W: Write>(&self, _w: W) -> Result<usize, Error>

impl Encode for String

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for Vec<u8>

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for bool

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for u8

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for u32

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl Encode for u64

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl<A: Encode, B: Encode> Encode for (A, B)

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

impl<T: Encode> Encode for &T

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

fn type_id(&self) -> Option<u32>

impl<T: Encode> Encode for Option<T>

fn encode<W: Write>(&self, w: W) -> Result<usize, Error>

Implementors

impl<C, T> Encode for WithChecksum<C, T>

where C: CodeqConfig, T: Encode,

impl<C> Encode for Segment<C>

where C: CodeqConfig,