Struct OptionalParameter

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

Expand description

A parameter that might not have a value, represented by Option<T>. 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> OptionalParameter<T>

pub fn get(&self) -> Option<T>

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

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

Assigns a value to the optional parameter, setting it to Some(value). Returns ParameterValueError::OutOfRange if the value is out of the parameter’s range.

pub fn unset(&self)

Unsets the optional parameter value to None.

Trait Implementations§

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

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

Formats the value using the given formatter. Read more

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

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<T: ParameterVariant> TryFrom<ParameterBuilder<'_, T>> for OptionalParameter<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.

Auto Trait Implementations§

impl<T> Freeze for OptionalParameter<T>

impl<T> RefUnwindSafe for OptionalParameter<T>
where T: RefUnwindSafe,

impl<T> Send for OptionalParameter<T>
where T: Send,

impl<T> Sync for OptionalParameter<T>
where T: Sync,

impl<T> Unpin for OptionalParameter<T>
where T: Unpin,

impl<T> UnwindSafe for OptionalParameter<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.