Struct ConfigPath 

pub struct ConfigPath(/* private fields */);

A path inside config/: relative, /-separated, with no empty, . or .. part, no \, : or NUL. Checked once here; the service checks only that it is the calling mod’s.

Implementations

impl ConfigPath

pub fn new(path: &str) -> Result<ConfigPath, ConfigFileError>

Checks path and makes a ConfigPath of it, or refuses with ConfigFileError::InvalidPath.

pub fn as_str(&self) -> &str

The path as written, /-separated.

pub fn owned_by(&self, mod_id: &str) -> bool

Whether the path is mod_id’s: its folder <mod_id>/ and anything in it, or a file beside it named <mod_id>.<ext> or <mod_id>-<rest> (NeoForge’s <mod_id>-common.toml). . and - are not id characters, so no other mod’s id starts the same way.

Trait Implementations

impl Clone for ConfigPath

fn clone(&self) -> ConfigPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigPath

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

Formats the value using the given formatter.

impl Eq for ConfigPath

impl Hash for ConfigPath

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

where __H: Hasher,

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 PartialEq for ConfigPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConfigPath

impl TryFrom<String> for ConfigPath

A path checked as ConfigPath::new checks it.

type Error = ConfigFileError

The type returned in the event of a conversion error.

fn try_from(path: String) -> Result<ConfigPath, ConfigFileError>

Performs the conversion.

impl Wire for ConfigPath

const MIN: usize = 4

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn take(input: &mut Reader<'_>) -> Result<ConfigPath, WireError>

Decodes one value, leaving any following bytes for the caller.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.