Struct postcard::flavors::Slice

pub struct Slice<'a> { /* fields omitted */ }

The Slice flavor is a storage flavor, storing the serialized (or otherwise modified) bytes into a plain [u8] slice. The Slice flavor resolves into a sub-slice of the original slice buffer.

Implementations

impl<'a> Slice<'a>

pub fn new(buf: &'a mut [u8]) -> Self

Create a new Slice flavor from a given backing buffer

Trait Implementations

impl<'a> Index<usize> for Slice<'a>

type Output = u8

The returned type after indexing.

fn index(&self, idx: usize) -> &u8

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<usize> for Slice<'a>

fn index_mut(&mut self, idx: usize) -> &mut u8

Performs the mutable indexing (container[index]) operation.

impl<'a> SerFlavor for Slice<'a>

type Output = &'a mut [u8]

The Output type is what this flavor "resolves" to when the serialization is complete. For storage flavors, this is typically a concrete type. For modification flavors, this is typically a generic parameter for the storage flavor they are wrapped around.

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.

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 release(self) -> Result<Self::Output, ()>

The release() trait method finalizes the modification or storage operation, and resolved into the type defined by SerFlavor::Output associated type.

fn try_push_varint_usize(&mut self, data: &VarintUsize) -> Result<(), ()>

The try_push_varint_usize() trait method can be used to push a VarintUsize. The default implementation uses try_extend() to process the encoded VarintUsize bytes, which is likely the desired behavior for most circumstances.