Struct ParameterName 

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

A validated job-parameter name.

Its Debug representation is redacted because parameter metadata is sensitive by default.

Implementations

impl ParameterName

pub fn new(value: impl Into<String>) -> Result<ParameterName, DomainError>

Validates and constructs the name.

Errors

Returns DomainError when the value is empty, too long, has surrounding whitespace, or contains a control character.

pub fn as_str(&self) -> &str

Borrows the validated value.

pub fn into_string(self) -> String

Returns the validated value.

Trait Implementations

impl AsRef<str> for ParameterName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for ParameterName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ParameterName

fn clone(&self) -> ParameterName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterName

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

Formats the value using the given formatter.

impl Display for ParameterName

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

Formats the value using the given formatter.

impl Eq for ParameterName

impl Hash for ParameterName

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 Ord for ParameterName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ParameterName

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

impl TryFrom<&str> for ParameterName

type Error = DomainError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<ParameterName, <ParameterName as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for ParameterName

type Error = DomainError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ParameterName, <ParameterName as TryFrom<String>>::Error>

Performs the conversion.