Struct vapix::v3::parameters::ParameterDefinition

pub struct ParameterDefinition {
    pub name: String,
    pub current_value: Option<String>,
    pub security_level: Option<u32>,
    pub nice_name: Option<String>,
    pub parameter_type: Option<ParameterTypeDefinition>,
}

A parameter definition.

Fields

name: String

The name of the parameter.

current_value: Option<String>

The current value of the parameter, if any, expressed as a string.

security_level: Option<u32>

The security level of the parameter.

nice_name: Option<String>

The name to display to the user, if different from name.

parameter_type: Option<ParameterTypeDefinition>

The type of this parameter, if provided.

Implementations

impl ParameterDefinition

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

Return this parameter as a bool. Returns None if this parameter has no current_value, has no parameter_type, has a parameter_type with a type_definition other than TypeDefinition::Bool, or if current_value is neither true_value nor false_value.

Trait Implementations

impl Debug for ParameterDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParameterDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.