Enum SettingsSpec 

pub enum SettingsSpec {
    Real {
        name: String,
        description: String,
        minimum: f64,
        maximum: f64,
        default: f64,
    },
    Integer {
        name: String,
        description: String,
        minimum: i64,
        maximum: i64,
        default: i64,
    },
    Boolean {
        name: String,
        description: String,
        default: bool,
    },
    Enumeration {
        name: String,
        description: String,
        values: Vec<String>,
        default: String,
    },
    String {
        name: String,
        description: String,
        default: String,
    },
}

Description of an environmental parameter.

Variants

Real

Fields

name: String

description: String

minimum: f64

Lower bound on the range of allowable values, inclusive.

maximum: f64

Upper bound on the range of allowable values, inclusive.

default: f64

Integer

Fields

name: String

description: String

minimum: i64

Lower bound on the range of allowable values, inclusive.

maximum: i64

Upper bound on the range of allowable values, inclusive.

default: i64

Boolean

Fields

name: String

description: String

default: bool

Enumeration

Fields

name: String

description: String

values: Vec<String>

Names of all of the variants of the enumeration.

default: String

String

Fields

name: String

description: String

default: String

Implementations

impl SettingsSpec

pub fn name(&self) -> &str

Name of this settings menu item, must be unique within the environment.

pub fn description(&self) -> &str

User facing documentation message.

pub fn type(&self) -> &str

Data type.

pub fn default(&self) -> String

Trait Implementations

impl Clone for SettingsSpec

fn clone(&self) -> SettingsSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SettingsSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SettingsSpec

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SettingsSpec