Cobs

postcard::ser_flavors

Struct Cobs

pub struct Cobs<B>where
    B: Flavor + IndexMut<usize, Output = u8>,
{ /* private fields */ }

Expand description

The Cobs flavor implements Consistent Overhead Byte Stuffing on the serialized data. The output of this flavor includes the termination/sentinel byte of 0x00.

This protocol is useful when sending data over a serial interface without framing such as a UART

Implementations§

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

pub fn try_new(bee: B) -> Result<Self>

Create a new Cobs modifier Flavor. If there is insufficient space to push the leading header byte, the method will return an Error

Trait Implementations§

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

type Output = <B as Flavor>::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.

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

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

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

Finalize the serialization process.

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.

Auto Trait Implementations§

impl<B> Freeze for Cobs<B>
where B: Freeze,

impl<B> RefUnwindSafe for Cobs<B>
where B: RefUnwindSafe,

impl<B> Send for Cobs<B>
where B: Send,

impl<B> Sync for Cobs<B>
where B: Sync,

impl<B> Unpin for Cobs<B>
where B: Unpin,

impl<B> UnwindSafe for Cobs<B>
where B: UnwindSafe,

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.