Trait Encode

pub trait Encode {
    // Required method
    fn encode<const CONFIG: u16>(
        &self,
        _: &mut (impl Write + ?Sized),
    ) -> Result<()>;

    // Provided method
    fn to_bytes<const CONFIG: u16>(&self) -> Vec<u8>  { ... }
}

This trait used to serialize the data structure into binary format.

Required Methods

fn encode<const CONFIG: u16>(&self, _: &mut (impl Write + ?Sized)) -> Result<()>

Serialize the data into binary format.

Provided Methods

fn to_bytes<const CONFIG: u16>(&self) -> Vec<u8>

This is a convenient method used to encode a value into binary data and return it as a Vec.

Example

use databuf::{Encode, config::num::LE};

#[derive(Encode)]
struct FooBar {
    foo: u8,
    bar: [u8; 2],
}
let bytes = FooBar { foo: 1, bar: [2, 3] }.to_bytes::<LE>();
assert_eq!(bytes, vec![1, 2, 3]);

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Encode for bool

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for char

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl Encode for f32

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for f64

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for i8

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for i16

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for i32

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for i64

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for i128

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for isize

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for str

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl Encode for u8

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for u16

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for u32

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for u64

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for u128

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for ()

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for usize

fn encode<const CONFIG: u16>( &self, writer: &mut (impl Write + ?Sized), ) -> Result<()>

impl Encode for String

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<'a, T> Encode for Cow<'a, T>

where T: ?Sized + Encode + ToOwned,

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<K: Encode, V: Encode> Encode for BTreeMap<K, V>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<K: Encode, V: Encode, S> Encode for HashMap<K, V, S>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T> Encode for Option<T>

where T: Encode,

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T> Encode for (T,)

where T: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T> Encode for PhantomData<T>

fn encode<const CONFIG: u16>(&self, _: &mut (impl Write + ?Sized)) -> Result<()>

impl<T, E> Encode for Result<T, E>

where T: Encode, E: Encode,

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T, T1> Encode for (T, T1)

where T: Encode, T1: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2> Encode for (T, T1, T2)

where T: Encode, T1: Encode, T2: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3> Encode for (T, T1, T2, T3)

where T: Encode, T1: Encode, T2: Encode, T3: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4> Encode for (T, T1, T2, T3, T4)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5> Encode for (T, T1, T2, T3, T4, T5)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6> Encode for (T, T1, T2, T3, T4, T5, T6)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7> Encode for (T, T1, T2, T3, T4, T5, T6, T7)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode, T11: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode, T11: Encode, T12: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode, T11: Encode, T12: Encode, T13: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode, T11: Encode, T12: Encode, T13: Encode, T14: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> Encode for (T, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)

where T: Encode, T1: Encode, T2: Encode, T3: Encode, T4: Encode, T5: Encode, T6: Encode, T7: Encode, T8: Encode, T9: Encode, T10: Encode, T11: Encode, T12: Encode, T13: Encode, T14: Encode, T15: Encode,

fn encode<const CONFIG: u16>( &self, _c: &mut (impl Write + ?Sized), ) -> Result<()>

impl<T, const N: usize> Encode for [T; N]

where T: Encode,

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + Copy> Encode for Cell<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + ?Sized> Encode for &T

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + ?Sized> Encode for &mut T

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + ?Sized> Encode for Box<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + ?Sized> Encode for Rc<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode + ?Sized> Encode for Arc<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for [T]

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for BinaryHeap<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for BTreeSet<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for LinkedList<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for VecDeque<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for Vec<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for RefCell<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for Range<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode> Encode for RangeInclusive<T>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

impl<T: Encode, S> Encode for HashSet<T, S>

fn encode<const CONFIG: u16>(&self, c: &mut (impl Write + ?Sized)) -> Result<()>

Implementors

impl Encode for BEU15

impl Encode for BEU22

impl Encode for BEU29

impl Encode for BEU30