Struct ParameterKey 

pub struct ParameterKey { /* private fields */ }

Stable structured identity for one refinable scalar.

Implementations

impl ParameterKey

pub fn new( module: impl Into<String>, owner_id: impl Into<String>, name: impl Into<String>, ) -> Result<Self, ParameterError>

Validate and own a three-segment parameter identity.

Errors

Returns ParameterError::InvalidKeySegment for empty, untrimmed, or delimiter-ambiguous segments.

pub fn module(&self) -> &str

Return the owning module segment.

pub fn owner_id(&self) -> &str

Return the stable owner segment.

pub fn name(&self) -> &str

Return the local parameter name.

pub fn label(&self) -> String

Return module[owner_id].name for diagnostics and reports.

Trait Implementations

impl Clone for ParameterKey

fn clone(&self) -> ParameterKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterKey

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

Formats the value using the given formatter.

impl Display for ParameterKey

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

Formats the value using the given formatter.

impl Eq for ParameterKey

impl Hash for ParameterKey

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 ParameterKey

fn cmp(&self, other: &ParameterKey) -> 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 ParameterKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ParameterKey

fn partial_cmp(&self, other: &ParameterKey) -> 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 StructuralPartialEq for ParameterKey