Enum OutboundPlain 

#[non_exhaustive]
pub enum OutboundPlain<'a> {
    Single(&'a [u8]),
    Multiple {
        chunks: &'a [&'a [u8]],
        start: usize,
        end: usize,
    },
}

A collection of borrowed plaintext slices.

Warning: OutboundPlain does not guarantee that the simplest variant is used. Multiple can hold non fragmented or empty payloads.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Single(&'a [u8])

A single byte slice.

Contrary to Multiple, this uses a single pointer indirection

Multiple

A collection of chunks (byte slices).

Fields

chunks: &'a [&'a [u8]]

A collection of byte slices that hold the buffered data.

start: usize

Offset of the payload’s first byte within the logical concatenation of all chunks.

This may point beyond the first chunk.

end: usize

Offset one past the payload’s last byte within the logical concatenation of all chunks, so end - start is the payload’s length in bytes.

Implementations

impl<'a> OutboundPlain<'a>

pub fn new(chunks: &'a [&'a [u8]]) -> Self

Create a payload from a slice of byte slices. If fragmented the cursors are added by default: start = 0, end = length

pub fn new_empty() -> Self

Create a payload with a single empty slice

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

Flatten the slice of byte slices to an owned vector of bytes

pub fn copy_to_vec(&self, vec: &mut Vec<u8>)

Append all bytes to a vector

pub fn chunks(&self) -> impl Iterator<Item = &'a [u8]> + '_

Iterate over the payload’s chunks of bytes, in order.

Empty chunks are not yielded.

pub fn single_chunk(&self) -> Option<&'a [u8]>

The payload’s single contiguous chunk, or None if it is fragmented.

An empty payload is treated as a single empty chunk. A Self::Multiple payload is contiguous when its selected range lies within one chunk. Distinct chunks are never joined, even if their addresses are adjacent.

pub fn len(&self) -> usize

Returns the cumulative length of all chunks

Trait Implementations

impl<'a> Clone for OutboundPlain<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OutboundPlain<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Vec<u8>> for OutboundPlain<'a>

fn from(payload: &'a Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<&'a [u8; N]> for OutboundPlain<'a>

fn from(payload: &'a [u8; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a [u8]> for OutboundPlain<'a>

fn from(payload: &'a [u8]) -> Self

Converts to this type from the input type.