Struct SettingDef 

pub struct SettingDef {
    pub key: String,
    pub kind: Kind,
    pub scopes: Vec<Scope>,
    pub overridable: bool,
    pub apply: Apply,
    pub default: Option<Value>,
    pub section: String,
    pub doc: String,
    pub process: Process,
}

The registry’s description of one setting.

Fields

key: String

The TOML path, e.g. embed.remote.endpoint.

kind: Kind

What the value must look like.

scopes: Vec<Scope>

The scopes it may be set in; the first is its home.

overridable: bool

Whether a device may override a value set in a wider scope.

apply: Apply

When a change takes effect.

default: Option<Value>

The value in effect when no scope sets it.

section: String

The heading it is listed under.

doc: String

One-line help text.

process: Process

The process that owns it; an older peer’s definitions read as the bridge’s.

Implementations

impl SettingDef

pub fn home(&self) -> Scope

The scope the setting normally lives in.

pub fn allows(&self, scope: Scope) -> bool

Whether the setting may be set in scope: its home, any other listed scope, or Device when it is overridable.

Trait Implementations

impl Clone for SettingDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SettingDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SettingDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SettingDef

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 SettingDef