Enum EntryStorage 

pub enum EntryStorage {
    Directory,
    Verbatim {
        label: VerbatimLabel,
        size: VerbatimSize,
    },
    Compressed {
        method: CompressionMethod,
        stored: Option<u64>,
        expanded: Option<u64>,
    },
}

How one container summary entry stores its bytes.

Variants

Directory

A container directory node that holds no bytes of its own.

Verbatim

Bytes stored verbatim, with whatever the container reports about their size.

Fields

label: VerbatimLabel

How this container spells verbatim storage.

size: VerbatimSize

What the container reports about the size.

Compressed

Bytes stored compressed; either size is absent when the codec does not report it.

The two sizes are independent facts: a compressed stream may occupy fewer, the same, or more stored bytes than it expands to (an incompressible deflate member grows), so no pair of reported sizes is invalid and none is a second spelling of another.

Fields

method: CompressionMethod

Compression method.

stored: Option<u64>

Stored size in bytes, absent when the codec does not report it.

expanded: Option<u64>

Expanded size in bytes, absent when the codec does not report it.

Implementations

impl EntryStorage

pub const fn verbatim(label: VerbatimLabel, size: u64) -> Self

Verbatim bytes occupying exactly size stored bytes.

pub const fn payload_only(label: VerbatimLabel, payload: u64) -> Self

Verbatim bytes whose payload is known and whose stored span is not reported.

pub fn framed( label: VerbatimLabel, payload: u64, stored_span: u64, ) -> Result<Self, &'static str>

Verbatim bytes whose stored span may include container framing.

The two numbers are independently declared by the container, so their order is a fact about the document: a stored span smaller than the payload is a malformed declaration and is rejected here, at the door that reads the container, not at the document wire.

pub fn framed_by( label: VerbatimLabel, payload: AllocatedLen, framing: NonZeroU32, ) -> Self

Verbatim bytes whose stored span is the payload plus framing bytes of container framing the producer knows.

Total: FramedSpan::from_parts mints every (payload, framing) pair a live allocation and a u32 framing can state.

pub const fn unreported(label: VerbatimLabel) -> Self

Verbatim bytes whose size the container does not report.

pub fn stored_size(&self) -> Option<u64>

Stored span in bytes, absent when the container reports none.

pub fn expanded_size(&self) -> Option<u64>

Expanded size in bytes, absent when the container reports none.

Trait Implementations

impl Clone for EntryStorage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntryStorage

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

Formats the value using the given formatter.

impl Eq for EntryStorage

impl PartialEq for EntryStorage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EntryStorage