Struct ParameterDescriptor

pub struct ParameterDescriptor {
    pub name: String,
    pub label: Option<String>,
    pub type: Option<String>,
    pub default_value: Option<String>,
}

A descriptor for a block parameter.

Fields

name: String

The machine-readable name of this parameter.

label: Option<String>

A human-readable label, if any, for this parameter.

type: Option<String>

The data type, if known, of this parameter.

default_value: Option<String>

A default value, if any, for this parameter.

Trait Implementations

impl Clone for ParameterDescriptor

fn clone(&self) -> ParameterDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterDescriptor

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

Formats the value using the given formatter.

impl Default for ParameterDescriptor

fn default() -> ParameterDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParameterDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ParameterDescriptor

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 MaybeLabeled for ParameterDescriptor

fn label(&self) -> Option<Cow<'_, str>>

Returns the human-readable label, if any, of the object.

fn is_labeled(&self) -> bool

Checks whether the object has a human-readable label.

impl Named for ParameterDescriptor

fn name(&self) -> Cow<'_, str>

Returns the name of the object.

impl Ord for ParameterDescriptor

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

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

fn partial_cmp(&self, other: &ParameterDescriptor) -> 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 Serialize for ParameterDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ParameterDescriptor

impl StructuralPartialEq for ParameterDescriptor