Struct DecodeContext 

pub struct DecodeContext<'a> { /* private fields */ }

Shared monotonic decode state.

Implementations

impl<'a> DecodeContext<'a>

pub fn read_root( reader: &mut dyn ReadSeek, arena: &'a DecodeArena, policy: &DecodePolicy, ) -> Result<(Self, View<'a>), CodecError>

Reads the root input under max_input_bytes, copies it into the arena, registers the root space, establishes input-proportional allowances, and returns the context and root view.

pub fn from_root_bytes( bytes: &'a [u8], arena: &'a DecodeArena, policy: &DecodePolicy, ) -> Result<(Self, View<'a>), CodecError>

Builds a context over caller-owned root bytes, for fuzz targets and tests. The arena still backs any expansions produced during decode.

pub fn policy(&self) -> &DecodePolicy

Returns the decode policy in force.

pub fn container_only(&self) -> bool

Returns whether the caller requested container-only decoding.

pub fn set_container_only(&mut self, value: bool)

Records the caller’s container-only request before decoding begins.

pub fn space_descriptors(&self) -> Vec<SpaceDescriptor>

Returns the stable descriptors registered for this decode session.

pub fn resolve_location(&self, location: SourceLocation) -> ResolvedAddress

Resolves a session-local location into an owned root-to-leaf address.

pub fn reserve_scoped( &self, bytes: u64, operation: &'static str, location: Option<SourceLocation>, ) -> Result<ScopedReservation<'_>, CodecError>

Reserves bytes held by a temporary materialization.

pub fn charge_retained( &self, bytes: u64, operation: &'static str, location: Option<SourceLocation>, ) -> Result<(), CodecError>

Charges bytes retained for the remainder of this session.

pub fn copy_retained( &self, bytes: &[u8], operation: &'static str, location: Option<SourceLocation>, ) -> Result<Vec<u8>, CodecError>

Copies bytes into session-retained storage after charging and reserving safely.

pub fn alloc_filled<T: Clone>( &self, count: usize, value: T, operation: &'static str, ) -> Result<Vec<T>, CodecError>

Allocates count copies of value after charging collection items and reserving without panicking on allocator refusal.

Prefer this over vec![value; parsed_count] for attacker-influenced sizes.

pub fn charge_entities( &self, count: u64, operation: &'static str, ) -> Result<(), CodecError>

Charges admitted entities.

pub fn admit_entities( &self, current: u64, admitted: &mut u64, operation: &'static str, ) -> Result<(), CodecError>

Charges entities newly present since admitted, then advances admitted.

Codecs call this at admission boundaries so max_entities refuses further work instead of only reporting after a finished IR is built.

pub fn charge_collection_items( &self, count: u64, operation: &'static str, ) -> Result<(), CodecError>

Charges admitted collection items.

pub fn enter_nested( &self, operation: &'static str, location: Option<SourceLocation>, ) -> Result<DepthGuard<'_>, CodecError>

Enters one recursive nesting level until the returned guard is dropped.

pub fn charge_work( &self, units: u64, operation: &'static str, ) -> Result<(), CodecError>

Charges session-global algorithm work, fusing on refusal.

pub fn work_budget(&self, local_limit: u64) -> WorkBudget<'_>

Creates a local work slice that also draws from the session allowance.

pub fn begin_expand( &self, source: View<'_>, spec: ExpandSpec, ) -> Result<ExpandWriter<'_, 'a>, CodecError>

Begins an expansion whose output is charged incrementally and becomes available only after successful finalization.

pub fn begin_expand_as( &self, source: View<'_>, spec: ExpandSpec, label: impl Into<String>, ) -> Result<ExpandWriter<'_, 'a>, CodecError>

Begins a labeled expansion so the derived space resolves to label.

pub fn concat_views(&self, inputs: &[View<'_>]) -> Result<View<'a>, CodecError>

Copies several input extents into one derived view.

pub fn register_slice<'v>( &self, parent: View<'v>, range: ByteRange, ) -> Result<View<'v>, CodecError>

Registers a stored (uncompressed) child range as a space that borrows the parent bytes without copying.

range is expressed in the parent view’s own space coordinates and must lie within the parent window; a range that escapes the parent is refused here, at the request site, exactly as View::child refuses. No bytes are copied. It is the archive-entry counterpart of DecodeContext::begin_expand — stored ZIP entries take this path, compressed ones take the expander. Registration still refuses on a fused context so a stored entry cannot be admitted after a refusal.

pub fn register_slice_as<'v>( &self, parent: View<'v>, range: ByteRange, label: impl Into<String>, ) -> Result<View<'v>, CodecError>

Registers a labeled stored child range so the space resolves to label.

pub fn finish_session(self) -> Result<(), CodecError>

Closes a decode or inspection session, returning a fused resource error even when codec code swallowed the charge that caused it.

Trait Implementations

impl<'a> Debug for DecodeContext<'a>

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

Formats the value using the given formatter.