Crate settings_schema

source ·

Structs

  • Type used to specify the default value for type Vec<(String, X)>.
    It allows setting the default for the dictionary (all entries) and the default key and value for new entries.
  • Type used to specify the default value for type Option.
    It allows specifying the set state and its content when it is set.
  • Type used to specify the default value for type Switch.
    It allows setting the enabled state and its content when set to enabled.
  • Type used to specify the default value for type Vec.
    It allows setting the default for the vector (all elements) and the default value for new elements.

Enums

  • GUI type associated to the choice node.
  • GUI type associated to a numeric node.
  • 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.
  • The Switch is used to represent something that makes sense to specify its state only when it’s enabled. This should be used differently than Option(al), that represent a value that can be omitted.

Traits

  • A data structure that can be deserialized from any data format supported by Serde.
  • A data structure that can be serialized into any data format supported by Serde.

Functions

  • Convert a T into serde_json::Value which is an enum that can represent any valid JSON data.

Derive Macros