Struct Parameters

pub struct Parameters<'a> { /* private fields */ }

Allows access to all parameters via get / set functions, using their name as a key.

Implementations

impl Parameters<'_>

pub fn get<T: ParameterVariant>(&self, name: &str) -> Option<T>

Tries to read a parameter of the requested type.

Returns Some(T) if a parameter of the requested type exists, None otherwise.

pub fn set<T: ParameterVariant>( &self, name: impl Into<Arc<str>>, value: T, ) -> Result<(), ParameterValueError>

Tries to set a parameter with the requested value.

Returns:

• Ok(()) if setting was successful.
• [Err(DeclarationError::TypeMismatch)] if the type of the requested value is different from the parameter’s type.
• [Err(DeclarationError::OutOfRange)] if the requested value is out of the parameter’s range.
• [Err(DeclarationError::ReadOnly)] if the parameter is read only.