Struct StreamChunks 

pub struct StreamChunks { /* private fields */ }

Available on crate feature reassembler only.

Reassembled output of one direction of a stream: in-order bytes, the gaps between them, and an optional terminal ReassemblyStop.

Built-in reassemblers use it as their ready buffer and append it to the caller’s StreamChunks on Reassembler::drain_into, so a driver can keep one scratch value and reuse its capacity across packets (no allocation in steady state).

Walk it in stream order with Self::iter:

use flowscope::{Chunk, StreamChunks};

let mut s = StreamChunks::new();
s.push_data(b"GET / HTTP/1.1\r\n");
s.push_gap(1200);
s.push_data(b"Host: example\r\n");
let parts: Vec<_> = s.iter().collect();
assert_eq!(parts[0], Chunk::Data(b"GET / HTTP/1.1\r\n"));
assert_eq!(parts[1], Chunk::Gap(1200));
assert_eq!(parts[2], Chunk::Data(b"Host: example\r\n"));

Implementations

impl StreamChunks

pub const fn new() -> Self

Empty value (no allocation).

pub fn clear(&mut self)

Clear bytes, gaps and stop; keeps the allocated capacity.

pub fn is_empty(&self) -> bool

true when there are no bytes, no gaps and no stop.

pub fn len(&self) -> usize

Number of data bytes (gaps excluded).

pub fn push_data(&mut self, data: &[u8])

Append contiguous bytes.

pub fn push_gap(&mut self, len: u64)

Record that len bytes are missing at the current end. Adjacent gaps coalesce; len == 0 is ignored.

pub fn set_stop(&mut self, stop: ReassemblyStop)

Mark the stream as stopped. The first reason wins.

pub fn stop(&self) -> Option<ReassemblyStop>

Why the stream stopped, if it did.

pub fn data(&self) -> &[u8]

All data bytes, concatenated, without gap information. Use Self::iter when gaps matter (they usually do).

pub fn gap_count(&self) -> usize

Number of gap markers.

pub fn gap_bytes(&self) -> u64

Total bytes missing across all gap markers.

pub fn iter(&self) -> Chunks<'_>

Walk data and gaps in stream order.

pub fn append(&mut self, other: &mut StreamChunks)

Move everything from other onto the end of self, leaving other empty and without capacity: a reassembler drained into a caller’s buffer keeps no memory. When self is empty the buffers are moved, not copied.

Trait Implementations

impl Clone for StreamChunks

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamChunks

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

Formats the value using the given formatter.

impl Default for StreamChunks

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StreamChunks

impl PartialEq for StreamChunks

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamChunks