Struct Envelope 

pub struct Envelope<'a> {
    pub token: Token,
    pub cursor: Option<&'a [u8]>,
    pub remaining: Option<u32>,
    pub frame: &'a [u8],
}

A parsed envelope borrowing from the payload it was read out of.

Fields

token: Token

cursor: Option<&'a [u8]>

The cursor to present in the next request, in a response; the position being continued, in a request.

remaining: Option<u32>

Advisory count of octets not yet returned.

frame: &'a [u8]

Exactly one ULCP frame, unparsed.

Implementations

impl<'a> Envelope<'a>

pub const fn new(token: Token, frame: &'a [u8]) -> Self

A bare envelope carrying frame and nothing else.

pub const fn with_cursor(self, cursor: &'a [u8]) -> Self

pub const fn with_remaining(self, remaining: u32) -> Self

pub fn parse(payload: &'a [u8]) -> Result<Self, EnvelopeError>

Read an envelope out of a payload, the payload type byte already stripped.

pub fn encode(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Write the envelope, returning its length.

pub fn overhead(&self) -> usize

Octets this envelope costs a payload beyond its frame.

Trait Implementations

impl<'a> Clone for Envelope<'a>

fn clone(&self) -> Envelope<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Envelope<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Envelope<'a>

fn eq(&self, other: &Envelope<'a>) -> 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<'a> Copy for Envelope<'a>

impl<'a> Eq for Envelope<'a>

impl<'a> StructuralPartialEq for Envelope<'a>