Struct StructBuffer

pub struct StructBuffer<M: StructLength> { /* private fields */ }

A buffer that accumulates bytes of sized structs and feeds them to provided sink function when messages are complete. This buffer handles partial messages and multiple messages in a single push.

Implementations

impl<M: StructLength> StructBuffer<M>

pub fn push<'a: 'b, 'b>( &'b mut self, bytes: &'a [u8], f: impl for<'c> FnMut(Result<M::Struct<'c>, ParseError>), )

Pushes bytes into the buffer, potentially feeding output to the function.

Lifetimes

• 'a: The lifetime of the input byte slice.
• 'b: The lifetime of the mutable reference to self.
• 'c: A lifetime used in the closure’s type, representing the lifetime of the M::Struct instances passed to it.

The constraint 'a: 'b ensures that the input bytes live at least as long as the mutable reference to self.

The for<'c> syntax in the closure type is a higher-ranked trait bound. It indicates that the closure must be able to handle M::Struct with any lifetime 'c. This is crucial because:

1. It allows the push method to create M::Struct instances with lifetimes that are not known at the time the closure is defined.
2. It ensures that the M::Struct instances passed to the closure are only valid for the duration of each call to the closure, not for the entire lifetime of the push method.
3. It prevents the closure from storing or returning these M::Struct instances, as their lifetime is limited to the scope of each closure invocation.

pub fn push_fallible<'a: 'b, 'b, E>( &'b mut self, bytes: &'a [u8], f: impl for<'c> FnMut(Result<M::Struct<'c>, ParseError>) -> Result<(), E>, ) -> Result<(), E>

Pushes bytes into the buffer, potentially feeding output to the function.

Lifetimes

• 'a: The lifetime of the input byte slice.
• 'b: The lifetime of the mutable reference to self.
• 'c: A lifetime used in the closure’s type, representing the lifetime of the M::Struct instances passed to it.

The constraint 'a: 'b ensures that the input bytes live at least as long as the mutable reference to self.

The for<'c> syntax in the closure type is a higher-ranked trait bound. It indicates that the closure must be able to handle M::Struct with any lifetime 'c. This is crucial because:

1. It allows the push method to create M::Struct instances with lifetimes that are not known at the time the closure is defined.
2. It ensures that the M::Struct instances passed to the closure are only valid for the duration of each call to the closure, not for the entire lifetime of the push method.
3. It prevents the closure from storing or returning these M::Struct instances, as their lifetime is limited to the scope of each closure invocation.

pub fn into_inner(self) -> VecDeque<u8>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Trait Implementations

impl<M: StructLength> Debug for StructBuffer<M>

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: StructLength> Default for StructBuffer<M>

fn default() -> Self

Returns the “default value” for a type.