Struct MandatoryParameter

pub struct MandatoryParameter<T: ParameterVariant> { /* private fields */ }

A parameter that must have a value This struct has ownership of the declared parameter. Additional parameter declaration will fail while this struct exists and the parameter will be undeclared when it is dropped.

Implementations

impl<T: ParameterVariant> MandatoryParameter<T>

pub fn get(&self) -> T

Returns a clone of the most recent value of the parameter.

pub fn set<U: Into<T>>(&self, value: U) -> Result<(), ParameterValueError>

Sets the parameter value. Returns ParameterValueError::OutOfRange if the value is out of the parameter’s range.

Trait Implementations

impl<T: ParameterVariant + Debug> Debug for MandatoryParameter<T>

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

Formats the value using the given formatter.

impl<T: ParameterVariant> Drop for MandatoryParameter<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ParameterVariant + 'a> TryFrom<ParameterBuilder<'a, T>> for MandatoryParameter<T>

type Error = DeclarationError

The type returned in the event of a conversion error.

fn try_from(builder: ParameterBuilder<'_, T>) -> Result<Self, Self::Error>

Performs the conversion.