HVec

postcard::ser_flavors

Struct HVec

pub struct HVec<const B: usize> { /* private fields */ }

Available on crate feature heapless only.

Expand description

The HVec flavor is a wrapper type around a heapless::Vec. This is a stack allocated data structure, with a fixed maximum size and variable amount of contents.

Implementations§

impl<const B: usize> HVec<B>

pub fn new() -> Self

Create a new, currently empty, heapless::Vec to be used for storing serialized output data.

Trait Implementations§

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

fn default() -> HVec<B>

Returns the “default value” for a type. Read more

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

type Output = Vec<u8, B>

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

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

Override this method when you want to customize 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<()>

Push a single byte to be modified and/or stored.

fn finalize(self) -> Result<Vec<u8, B>>

Finalize the serialization process.

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

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation. Read more

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

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

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

Auto Trait Implementations§

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

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

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

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

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

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

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.