Trait postcard::ser_flavors::Flavor

pub trait Flavor {
    type Output;

    // Required methods
    fn try_push(&mut self, data: u8) -> Result<()>;
    fn finalize(self) -> Result<Self::Output>;

    // Provided method
    fn try_extend(&mut self, data: &[u8]) -> Result<()> { ... }
}

The serialization Flavor trait

This is used as the primary way to encode serialized data into some kind of buffer, or modify that data in a middleware style pattern.

See the module level docs for an example of how flavors are used.

Required Associated Types

type Output

The Output type is what this storage “resolves” to when the serialization is complete, such as a slice or a Vec of some sort.

Required Methods

fn try_push(&mut self, data: u8) -> Result<()>

The try_push() trait method can be used to push a single byte to be modified and/or stored

fn finalize(self) -> Result<Self::Output>

Finalize the serialization process

Provided Methods

fn try_extend(&mut self, data: &[u8]) -> Result<()>

The try_extend() trait method can be implemented when there is a more efficient way of processing multiple bytes at once, such as copying a slice to the output, rather than iterating over one byte at a time.

Implementors

impl Flavor for AllocVec

type Output = Vec<u8, Global>

impl Flavor for Size

type Output = usize

impl<'a> Flavor for Slice<'a>

type Output = &'a mut [u8]

impl<'a, B> Flavor for CrcModifier<'a, B, u8>where B: Flavor,

Available on crate feature use-crc only.

type Output = <B as Flavor>::Output

impl<'a, B> Flavor for CrcModifier<'a, B, u16>where B: Flavor,

Available on crate feature use-crc only.

type Output = <B as Flavor>::Output

impl<'a, B> Flavor for CrcModifier<'a, B, u32>where B: Flavor,

Available on crate feature use-crc only.

type Output = <B as Flavor>::Output

impl<'a, B> Flavor for CrcModifier<'a, B, u64>where B: Flavor,

Available on crate feature use-crc only.

type Output = <B as Flavor>::Output

impl<'a, B> Flavor for CrcModifier<'a, B, u128>where B: Flavor,

Available on crate feature use-crc only.

type Output = <B as Flavor>::Output

impl<B> Flavor for Cobs<B>where B: Flavor + IndexMut<usize, Output = u8>,

type Output = <B as Flavor>::Output

impl<T> Flavor for postcard::ser_flavors::eio::WriteFlavor<T>where T: Write,

type Output = T

impl<T> Flavor for postcard::ser_flavors::io::WriteFlavor<T>where T: Write,

type Output = T

impl<T> Flavor for ExtendFlavor<T>where T: Extend<u8>,

type Output = T

impl<const B: usize> Flavor for HVec<B>

type Output = Vec<u8, B>