Struct Payload 

pub struct Payload { /* private fields */ }

Available on crate feature pipeline only.

The segment payload threaded through the pipeline. A segment payload — zero or more contiguous Bytes chunks.

Cloning a Payload is cheap: each chunk is Bytes, which clones via an Arc bump.

Implementations

impl Payload

pub fn new() -> Self

Create an empty payload.

pub fn from_bytes(b: Bytes) -> Self

Wrap a single Bytes as a payload.

pub fn from_vec(v: Vec<u8>) -> Self

Wrap a Vec<u8> as a payload (zero-copy via Bytes::from).

pub fn len(&self) -> usize

Total byte length across all chunks.

pub fn is_empty(&self) -> bool

True when the payload has no bytes.

pub fn chunk_count(&self) -> usize

Number of chunks. Useful for tests that want to verify zero-copy.

pub fn chunks(&self) -> &[Bytes]

Borrow the chunk slice. Stable order; may be empty.

pub fn iter(&self) -> Iter<'_, Bytes>

Iterate over chunks in order.

pub fn push(&mut self, b: Bytes)

Append a chunk. Empty chunks are dropped to keep chunk_count honest.

pub fn starts_with(&self, prefix: &[u8]) -> bool

Check whether the payload begins with prefix. Walks across chunk boundaries so callers do not have to know the internal layout.

pub fn into_bytes(self) -> Bytes

Concatenate chunks into a single contiguous Bytes.

Fast path: if there is exactly one chunk, it is returned as-is (zero-copy). Otherwise a BytesMut of self.len() is allocated and each chunk is copied in order.

pub fn into_vec(self) -> Vec<u8>

Concatenate chunks into a single contiguous Vec<u8>.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Payload

Returns the “default value” for a type.

impl<const N: usize> From<&'static [u8; N]> for Payload

fn from(s: &'static [u8; N]) -> Self

Converts to this type from the input type.

impl From<&'static [u8]> for Payload

fn from(s: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<Bytes> for Payload

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Payload

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.