Enum ParameterType

#[repr(i32)]
pub enum ParameterType {
    ParamTypeUndefined = 0,
    Input = 1,
    Output = 16,
    Parameter = 256,
    ParameterVolatile = 257,
    ParameterPersistent = 258,
}

Parameter’s IO types.

Each parameter in the tree can be an INPUT, an OUTPUT or a PARAMETER.

PARAMETER type is both an input and output, it can be saved and loaded from the disk.

Value of a parameter with OUTPUT type cannot be set, but can be overwritten (forced). Force operation on the OUTPUT will only change the parameter value on everything that is linked to it. It will NOT change the internal value of the block to which the output belongs.

Variants

ParamTypeUndefined = 0

Input = 1

Input parameter.

Output = 16

Output parameter.

Parameter = 256

Input/output parameter, which is saved and loaded from the disk on request.

ParameterVolatile = 257

Input/output parameter, which is valotile, not saved or loaded from the disk.

ParameterPersistent = 258

Input/output parameter, which is persistent, continuously saved and loaded from the disk.

Implementations

impl ParameterType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of ParameterType.

pub fn from_i32(value: i32) -> Option<ParameterType>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a ParameterType, or None if value is not a valid variant.

impl ParameterType

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for ParameterType

fn clone(&self) -> ParameterType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterType

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

Formats the value using the given formatter.

impl Default for ParameterType

fn default() -> ParameterType

Returns the “default value” for a type.

impl From<ParameterType> for i32

fn from(value: ParameterType) -> i32

Converts to this type from the input type.

impl Hash for ParameterType

fn hash<__H: Hasher>(&self, state: &mut __H)

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 Hash for ParameterType

const HASH: u32 = 690_447_499u32

impl Ord for ParameterType

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ParameterType

fn partial_cmp(&self, other: &ParameterType) -> 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 TryFrom<i32> for ParameterType

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<ParameterType, UnknownEnumValue>

Performs the conversion.

impl Copy for ParameterType

impl Eq for ParameterType

impl StructuralPartialEq for ParameterType