Struct ParamRef

#[non_exhaustive]
pub struct ParamRef<'a> {
    pub config: ConfigRef<'a>,
    pub param: &'static ParamMetadata,
}

Reference to a parameter on a configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

config: ConfigRef<'a>

Reference to the configuration containing the param.

param: &'static ParamMetadata

Param metadata.

Implementations

impl<'a> ParamRef<'a>

pub fn canonical_path(&self) -> String

Returns canonical path to the param.

pub fn all_paths(&self) -> impl Iterator<Item = (String, AliasOptions)> + '_

Iterates over all paths to the param.

Trait Implementations

impl<'a> Clone for ParamRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParamRef<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for ParamRef<'a>