Struct ChunkList 

pub struct ChunkList(/* private fields */);

Sender side: an ordered list of Chunks for one message. Build it from the payload with ChunkList::split, passing the per-message data size to cut at (the connection’s negotiated max_message_size minus the envelope reserve), then iterate (or convert to Vec<Chunk>) to put each chunk on the wire. The cut size is a runtime argument rather than a type parameter because it is decided per connection from the negotiated limit. Reassembly is the receiver’s job — see MessageReassembler.

Implementations

impl ChunkList

pub fn split(bytes: &Bytes, chunk_size: usize) -> ChunkList

Eagerly split bytes into chunks of at most chunk_size data bytes each, tagged [i, total]. A test/helper constructor (the production send path uses stream, and WireReserves::plan never yields an unusable chunk_size — it returns None instead). chunk_size is clamped to ≥ 1 only as a defensive guard against a caller passing 0; it is not a sanctioned way to produce 1-byte chunks on the wire.

pub fn stream(bytes: Bytes, chunk_size: usize) -> impl Iterator<Item = Chunk>

Stream bytes into chunks of at most chunk_size data bytes each without materializing the whole list: each chunk’s data is a zero-copy Bytes::slice of the input, and the chunks are yielded lazily, so a sender can frame and flush one chunk at a time with bounded memory (rather than allocating every chunk up front). All chunks share one [i, total] numbering and one ChunkMeta. chunk_size is clamped to ≥ 1 so a degenerate value still terminates; empty input yields no chunks, agreeing with split.

pub fn to_vec(&self) -> Vec<Chunk>

Clone out the chunks.

pub fn as_vec(&self) -> &Vec<Chunk>

Borrow the chunks.

Trait Implementations

impl Clone for ChunkList

fn clone(&self) -> ChunkList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChunkList

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

Formats the value using the given formatter.

impl Default for ChunkList

fn default() -> ChunkList

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChunkList

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChunkList, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ChunkList> for Vec<Chunk>

fn from(l: ChunkList) -> Vec<Chunk>

Converts to this type from the input type.

impl From<Vec<Chunk>> for ChunkList

fn from(data: Vec<Chunk>) -> ChunkList

Converts to this type from the input type.

impl IntoIterator for &ChunkList

type Item = Chunk

The type of the elements being iterated over.

type IntoIter = IntoIter<Chunk>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&ChunkList as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for ChunkList

type Item = Chunk

The type of the elements being iterated over.

type IntoIter = IntoIter<Chunk>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ChunkList as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Serialize for ChunkList

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.