Struct Assembler 

pub struct Assembler { /* private fields */ }

A buffer (re)assembler.

Currently, up to a hardcoded limit of 4 or 32 holes can be tracked in the buffer.

Implementations

impl Assembler

pub const fn new() -> Assembler

Create a new buffer assembler.

pub fn clear(&mut self)

pub fn peek_front(&self) -> usize

Return length of the front contiguous range without removing it from the assembler

pub fn is_empty(&self) -> bool

Return whether the assembler contains no data.

pub fn add( &mut self, offset: usize, size: usize, ) -> Result<(), TooManyHolesError>

Add a new contiguous range to the assembler, or return Err(TooManyHolesError) if too many discontinuities are already recorded.

pub fn remove_front(&mut self) -> usize

Remove a contiguous range from the front of the assembler. If no such range, return 0.

pub fn add_then_remove_front( &mut self, offset: usize, size: usize, ) -> Result<usize, TooManyHolesError>

Add a segment, then remove_front.

This is equivalent to calling add then remove_front individually, except it’s guaranteed to not fail when offset = 0. This is required for TCP: we must never drop the next expected segment, or the protocol might get stuck.

pub fn iter_data(&self) -> impl Iterator<Item = (usize, usize)> + '_

Iterate over all of the contiguous data ranges.

Returns (offset, size) tuples for each contiguous data range, where offset is relative to the start of the assembler.

Data Hole Data |— 100 —|— 200 —|— 100 —|

Would return the ranges: (0, 100), (300, 400)

Trait Implementations

impl Clone for Assembler

fn clone(&self) -> Assembler

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Assembler

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

Formats the value using the given formatter.

impl Display for Assembler

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

Formats the value using the given formatter.

impl PartialEq for Assembler

fn eq(&self, other: &Assembler) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Assembler

impl StructuralPartialEq for Assembler