Enum SchemaNode

#[non_exhaustive]
pub enum SchemaNode {
    Section(Vec<SchemaEntry<SchemaNode>>),
    Choice {
        default: String,
        variants: Vec<SchemaEntry<Option<SchemaNode>>>,
        gui: Option<ChoiceControlType>,
    },
    Optional {
        default_set: bool,
        content: Box<SchemaNode>,
    },
    Switch {
        default_enabled: bool,
        content: Box<SchemaNode>,
    },
    Boolean {
        default: bool,
    },
    Number {
        default: f64,
        ty: NumberType,
        gui: NumericGuiType,
        suffix: Option<String>,
    },
    Range {
        default: [f64; 2],
        ty: NumberType,
        gui: NumericGuiType,
        suffix: Option<String>,
    },
    Percentage {
        default_normalized: f32,
        range_normalized: Option<RangeInclusive<f32>>,
    },
    Duration {
        default: Duration,
        range: RangeInclusive<Duration>,
        logarithmic: bool,
    },
    Text {
        default: String,
    },
    Array(Vec<SchemaNode>),
    Vector {
        default_element: Box<SchemaNode>,
        default: Value,
    },
    Dictionary {
        default_key: String,
        default_value: Box<SchemaNode>,
        default: Value,
    },
}

Schema base type returned by <YourStructOrEnum>::schema(), generated by the macro #[derive(SettingsSchema)]. It can be used as is (for Rust based GUIs) or it can be serialized to JSON for creating GUIs in other languages.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Section(Vec<SchemaEntry<SchemaNode>>)

Choice

Fields

default: String

variants: Vec<SchemaEntry<Option<SchemaNode>>>

gui: Option<ChoiceControlType>

Optional

Fields

default_set: bool

content: Box<SchemaNode>

Switch

Fields

default_enabled: bool

content: Box<SchemaNode>

Boolean

Fields

default: bool

Number

Fields

default: f64

ty: NumberType

gui: NumericGuiType

suffix: Option<String>

Range

Fields

default: [f64; 2]

ty: NumberType

gui: NumericGuiType

suffix: Option<String>

Percentage

Fields

default_normalized: f32

range_normalized: Option<RangeInclusive<f32>>

Duration

Fields

default: Duration

range: RangeInclusive<Duration>

logarithmic: bool

Text

Fields

default: String

Array(Vec<SchemaNode>)

Vector

Fields

default_element: Box<SchemaNode>

default: Value

Dictionary

Fields

default_key: String

default_value: Box<SchemaNode>

default: Value

Trait Implementations

impl Clone for SchemaNode

fn clone(&self) -> SchemaNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaNode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaNode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.