Struct NestedFramer 

pub struct NestedFramer<Inner, Outer> { /* private fields */ }

A nested framer that extracts inner frames from outer frames.

This framer takes two input framers – the “outer” and “inner” framers – and extracts outer frames, and once an outer frame has been extract, extracts as many inner frames from the outer frame as possible. Callers deal exclusively with the extracted inner frames.

Implementations

impl<Inner, Outer> NestedFramer<Inner, Outer>

pub fn new(inner: Inner, outer: Outer) -> Self

Creates a new NestedFramer from the given inner and outer framers.

pub fn take_completed_outer_frames(&mut self) -> usize

Returns the number of outer frames that have been fully consumed since the last call.

pub fn set_retain_outer_frames(&mut self, retain: bool)

Sets whether newly extracted outer frames are retained for later retrieval.

When enabled, every outer frame extracted from the input buffer is retained, in order, until it is drained with drain_outer_frames. Retained frames share their underlying storage with the frame being split into inner frames, so retaining them does not copy the frame data.

Callers that enable retention MUST drain retained frames after each call to next_frame, as they are otherwise held indefinitely. Disabling retention discards any frames that have not yet been drained.

Defaults to disabled.

pub fn drain_outer_frames(&mut self) -> Drain<'_, Bytes>

Drains the outer frames retained since the last call, in the order they were extracted.

Trait Implementations

impl<Inner, Outer> Framer for NestedFramer<Inner, Outer>

where Inner: Framer, Outer: Framer,

fn next_frame<B: ReadIoBuffer>( &mut self, buf: &mut B, is_eof: bool, ) -> Result<Option<Bytes>, FramingError>

Attempt to extract the next frame from the buffer.