Struct FramedSpan 

pub struct FramedSpan { /* private fields */ }

A verbatim payload inside a strictly larger stored span.

The framing is the declared number and it is non-zero, so a stored span that does not exceed its payload is unrepresentable. The stored span is derived from the pair and never stated beside it, so a span that disagrees with its own payload and framing is unrepresentable too.

Implementations

impl FramedSpan

pub const fn from_parts(payload: AllocatedLen, framing: NonZeroU32) -> Self

A payload-byte payload wrapped in framing bytes of container framing.

payload is the length of a live allocation and so at most isize::MAX and framing at most u32::MAX, and the module assertions above prove that sum inside u64, so Self::stored adds it unchecked and this mint is total.

pub fn payload(self) -> u64

Payload size in bytes.

pub fn stored(self) -> u64

Stored span in bytes, framing included: at least payload + 1, since the framing is non-zero.

The payload is a live allocation and the framing a u32, which the module assertions prove sum inside u64, so this addition is total for every span the type can hold.

Trait Implementations

impl Clone for FramedSpan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FramedSpan

impl Debug for FramedSpan

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

Formats the value using the given formatter.

impl Eq for FramedSpan

impl PartialEq for FramedSpan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FramedSpan