Trait FrameSink 

pub trait FrameSink {
    // Required methods
    fn clear(&mut self);
    fn frame_len(&self) -> usize;
    fn free_capacity(&self) -> usize;
    fn push(&mut self, byte: u8) -> Result<(), FrameSinkError>;
    fn extend_from_slice(&mut self, run: &[u8]) -> Result<(), FrameSinkError>;
}

Writes are all-or-nothing: a push or extend_from_slice that would exceed the sink’s capacity appends nothing and returns FrameSinkError::Full, so a rejected frame never leaves a partial tail behind.

Required Methods

fn clear(&mut self)

fn frame_len(&self) -> usize

fn free_capacity(&self) -> usize

fn push(&mut self, byte: u8) -> Result<(), FrameSinkError>

fn extend_from_slice(&mut self, run: &[u8]) -> Result<(), FrameSinkError>

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl FrameSink for Vec<u8>

Available on crate feature std only.

fn clear(&mut self)

fn frame_len(&self) -> usize

fn free_capacity(&self) -> usize

fn push(&mut self, byte: u8) -> Result<(), FrameSinkError>

fn extend_from_slice(&mut self, run: &[u8]) -> Result<(), FrameSinkError>

Implementors

impl<const FRAME: usize> FrameSink for FrameSlot<FRAME>

As a FrameSink the slot is a streaming deframer’s destination: len is the accumulation cursor, and the committer stamps target when the frame is done.