Trait Encoder

pub trait Encoder {
    // Required method
    fn encoder(&self, _: &mut impl Write) -> Result<()>;

    // Provided method
    fn encode(&self) -> Vec<u8>  { ... }
}

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

Required Methods

fn encoder(&self, _: &mut impl Write) -> Result<()>

Serialize the data into binary format.

Provided Methods

fn encode(&self) -> Vec<u8>

Example

use bin_layout::Encoder;

#[derive(Encoder)]
struct FooBar {
    foo: u8,
    bar: [u8; 2],
}
let bytes = FooBar { foo: 1, bar: [2, 3] }.encode();
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 Encoder for bool

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for char

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl Encoder for f32

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for f64

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for i8

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for i16

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for i32

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for i64

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for i128

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for isize

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for str

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl Encoder for u8

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for u16

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for u32

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for u64

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for u128

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for ()

fn encoder(&self, _c: &mut impl Write) -> Result<()>

impl Encoder for usize

fn encoder(&self, writer: &mut impl Write) -> Result<()>

impl Encoder for String

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

where T: ?Sized + Encoder + ToOwned,

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T> Encoder for (T,)

where T: Encoder,

fn encoder(&self, _c: &mut impl Write) -> Result<()>

impl<T> Encoder for PhantomData<T>

fn encoder(&self, _: &mut impl Write) -> Result<()>

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

where T: Encoder, T1: Encoder,

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

where T: Encoder, T1: Encoder, T2: Encoder,

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

where T: Encoder, T1: Encoder, T2: Encoder, T3: Encoder,

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

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

fn encoder(&self, _c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for Option<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for [T]

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for BinaryHeap<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for BTreeSet<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for LinkedList<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for VecDeque<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for Vec<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for RefCell<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for Range<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder> Encoder for RangeInclusive<T>

fn encoder(&self, c: &mut impl Write) -> Result<()>

impl<T: Encoder, E: Encoder> Encoder for Result<T, E>

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

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

fn encoder(&self, c: &mut impl Write) -> Result<()>

Implementors

impl Encoder for L2

impl Encoder for L3

impl<Len: LenType> Encoder for Record<Len, &str>

impl<Len: LenType> Encoder for Record<Len, String>

impl<Len: LenType, K: Encoder, V: Encoder> Encoder for Record<Len, BTreeMap<K, V>>

impl<Len: LenType, K: Encoder, V: Encoder, S> Encoder for Record<Len, HashMap<K, V, S>>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, &[T]>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, BinaryHeap<T>>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, BTreeSet<T>>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, LinkedList<T>>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, VecDeque<T>>

impl<Len: LenType, T: Encoder> Encoder for Record<Len, Vec<T>>

impl<Len: LenType, T: Encoder, S> Encoder for Record<Len, HashSet<T, S>>