Struct ParameterValue 

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

A bounded typed job-parameter value.

Debug and Display intentionally redact the underlying value. Use the typed accessors only at an application or persistence boundary that is authorized to consume the parameter.

Implementations

impl ParameterValue

pub fn string(value: impl Into<String>) -> Result<ParameterValue, DomainError>

Validates and constructs a string parameter.

Errors

Returns DomainError::ParameterStringTooLong when the UTF-8 value is larger than 64 KiB.

pub const fn kind(&self) -> ParameterValueKind

Returns the stable type discriminator.

pub fn as_str(&self) -> Option<&str>

Borrows the string value when this is a string parameter.

pub const fn as_i64(&self) -> Option<i64>

Returns the signed integer when this is an i64 parameter.

pub const fn as_u64(&self) -> Option<u64>

Returns the unsigned integer when this is a u64 parameter.

pub const fn as_bool(&self) -> Option<bool>

Returns the boolean when this is a boolean parameter.

Trait Implementations

impl Clone for ParameterValue

fn clone(&self) -> ParameterValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterValue

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

Formats the value using the given formatter.

impl Display for ParameterValue

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

Formats the value using the given formatter.

impl Eq for ParameterValue

impl From<bool> for ParameterValue

fn from(value: bool) -> ParameterValue

Converts to this type from the input type.

impl From<i64> for ParameterValue

fn from(value: i64) -> ParameterValue

Converts to this type from the input type.

impl From<u64> for ParameterValue

fn from(value: u64) -> ParameterValue

Converts to this type from the input type.

impl Hash for ParameterValue

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 ParameterValue

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ParameterValue

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

impl TryFrom<&str> for ParameterValue

type Error = DomainError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for ParameterValue

type Error = DomainError

The type returned in the event of a conversion error.

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

Performs the conversion.