Struct DecodeLimits 

#[non_exhaustive]
pub struct DecodeLimits {
    pub max_decoded_bytes: u64,
    /* private fields */
}

Resource limits for decode_entries_with.

A pack’s wire size says little about what decoding it allocates: a 0x03/0x04 entry may claim up to MAX_RAW_OBJECT_SIZE bytes from a few-byte zstd frame, a delta may declare a result of the same size from a short run of copies, and a tiny delta may name a huge external base. A decoder that held all of that until the pack ends would let a sub-kilobyte pack pin gigabytes. decode_entries_with therefore charges every such allocation against Self::max_decoded_bytes and rejects the pack with PackError::PackfileTooLarge once the total passes it.

The budget is per call. It bounds one decode, not a process: a server running several decodes at once (WP-4.7) must size it from its isolate’s memory limit divided by its decode concurrency. The default, Self::DEFAULT_MAX_DECODED_BYTES (1 GiB), equals the largest object the format allows (MAX_RAW_OBJECT_SIZE) so that any single valid object decodes; it is not sized for a constrained isolate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_decoded_bytes: u64

Cap on the bytes one decode may hold beyond the pack itself: every 0x03/0x04 entry’s claimed uncompressed_len, every delta’s declared result length, and every external base fetched from the DeltaBaseSource while it is cached. 0x00 payloads are borrowed from the pack and do not count. An external base is measured once fetched, so the peak can pass the cap by the one base whose fetch trips it.

Implementations

impl DecodeLimits

pub const DEFAULT_MAX_DECODED_BYTES: u64

Default Self::max_decoded_bytes: 1 GiB, the maximum object size (MAX_RAW_OBJECT_SIZE). Servers set their own (see the type docs).

pub const fn with_max_decoded_bytes(self, bytes: u64) -> Self

These limits with Self::max_decoded_bytes set to bytes.

pub const fn with_entry_geometry(self, frame: u64, delta_stream: u64) -> Self

Bound encoded payloads and delta streams separately from canonical bytes.

Trait Implementations

impl Clone for DecodeLimits

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 DecodeLimits

impl Debug for DecodeLimits

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

Formats the value using the given formatter.

impl Default for DecodeLimits

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DecodeLimits

impl PartialEq for DecodeLimits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecodeLimits