Struct DecodeCx 

pub struct DecodeCx<'a> {
    pub limits: Limits,
    pub bundle: Option<&'a Bundle>,
}

What a format has besides the file it decodes: the limits, and the bundle the file is in, for the files it names (a sidecar’s picture, a manifest’s sounds). Without a bundle, every file named is missing.

Fields

limits: Limits

The limits of this decoding.

bundle: Option<&'a Bundle>

The bundle the file is in, if any.

Implementations

impl<'a> DecodeCx<'a>

pub const fn new() -> Self

No bundle, no limits but the formats’ own: for bytes decoded alone.

pub const fn in_bundle(bundle: &'a Bundle) -> Self

Decoding a file of bundle.

pub const fn with_limits(self, limits: Limits) -> Self

This context, with limits.

pub fn has(&self, path: &str) -> bool

Whether the bundle has the file at path (Bundle::has).

pub fn bytes(&self, path: &str) -> Option<&'static [u8]>

The bytes of the file at path (relative to a layer’s root), if the bundle has it.

pub fn text(&self, path: &str) -> Option<&'static str>

The text of the file at path, if the bundle has it and it is valid UTF-8.

pub fn shown(&self, path: &str) -> String

The name errors show the file at path by.

pub fn left_out(&self, path: &str) -> bool

Whether the bundle leaves the file at path out on purpose (Bundle::left_out).

pub fn files_under(&self, dir: &str) -> Vec<&'static str>

The paths of the files inside directory dir or below it (Bundle::files_under); none without a bundle.

pub fn import_settings<S: ImportSettings>( &self, file: &AssetPath, ) -> Result<S, Vec<ContentError>>

The import settings S of file (ADR-0057): its section in the nearest settings file of settings_chain that has one (the file’s own .meta, then each folder’s _folder.meta up to the root), whole; S::default() without a bundle or when none has it. Each file looked for is read with bytes, so the watcher hears of it, found or not. A settings file on the way that doesn’t read is an error, even when a farther one has the section.

Trait Implementations

impl<'a> Clone for DecodeCx<'a>

fn clone(&self) -> DecodeCx<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DecodeCx<'a>

impl<'a> Debug for DecodeCx<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DecodeCx<'a>

fn default() -> DecodeCx<'a>

Returns the “default value” for a type.