Struct Metadata

pub struct Metadata {
    pub path: Option<PathBuf>,
    pub source: Source,
    pub level: u8,
    pub trust: Trust,
}

Additional information about a section.

Fields

path: Option<PathBuf>

The file path of the source, if known.

source: Source

Where the section is coming from.

level: u8

The levels of indirection of the file, with 0 being a section that was directly loaded, and 1 being an include.path of a level 0 file.

trust: Trust

The trust-level for the section this meta-data is associated with.

Implementations

impl Metadata

Instantiation

pub fn api() -> Self

Return metadata indicating the source of a File is from an API user.

pub fn try_from_path(path: impl Into<PathBuf>, source: Source) -> Result<Self>

Return metadata as derived from the given path at source, which will also be used to derive the trust level by checking its ownership.

pub fn with(self, trust: Trust) -> Self

Set the trust level of this instance to the given trust and return it.

Useful in conjunction with Metadata::from(source).

pub fn at(self, path: impl Into<PathBuf>) -> Self

Set the metadata to be located at the given path.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Self

Returns the “default value” for a type.

impl From<Source> for Metadata

fn from(source: Source) -> Self

Converts to this type from the input type.

impl Hash for Metadata

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Metadata

fn cmp(&self, other: &Metadata) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Metadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Metadata

fn partial_cmp(&self, other: &Metadata) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Metadata

impl StructuralPartialEq for Metadata