Skip to main content

Chain

Enum Chain 

Source
#[non_exhaustive]
pub enum Chain { Codec { codec: FormatId, inner: Box<Chain>, }, Container { container: FormatId, }, Raw, }
Expand description

A resolved decode pipeline.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Codec

A codec wrapping something else. Decode order: this codec, then inner.

Fields

§codec: FormatId
§inner: Box<Chain>
§

Container

A container of entries.

Fields

§container: FormatId
§

Raw

Opaque bytes. The terminal case for a bare compressed file.

Implementations§

Source§

impl Chain

Source

pub fn container(&self) -> Option<FormatId>

The container this chain resolves to, if any, at ANY depth.

Some(tar) for tar over gzip as well as for a bare tar: however many codec layers sit above it, the entries live in a container, and a caller that has not OPENED that container cannot speak for its fidelity. That is the whole use — ops::inspect identifies a stream WITHOUT decoding it, so it never opens the container and must not report a fidelity conclusion it did not reach. See ops::Inspection::fidelity_evaluated.

The _ arm covers Chain::Raw and anything added later: Chain is #[non_exhaustive], and “no container” is the right answer for a shape this method does not recognise, since the caller’s only use of Some is to withhold a claim.

Source

pub fn outermost_codec(&self) -> Option<FormatId>

The outermost codec, if any — the layer a writer must create FIRST, because the container writes into it.

Deliberately only the outermost, and deliberately NOT recursive the way Chain::container is: a write-side chain is at most one codec deep. MAX_CHAIN_DEPTH bounds the READ side, where deeper nesting is a hostile-input concern rather than a shape stuffr emits, and a recursive answer here would let a caller silently write only the innermost of several codecs.

Source

pub fn describe(&self) -> String

Human-readable form, innermost first: "tar over gzip".

Trait Implementations§

Source§

impl Clone for Chain

Source§

fn clone(&self) -> Chain

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Chain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Chain

Source§

impl PartialEq for Chain

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Chain

Auto Trait Implementations§

§

impl Freeze for Chain

§

impl RefUnwindSafe for Chain

§

impl Send for Chain

§

impl Sync for Chain

§

impl Unpin for Chain

§

impl UnsafeUnpin for Chain

§

impl UnwindSafe for Chain

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.