Struct Description 

pub struct Description {
    pub id: String,
    pub name: String,
    pub description: String,
    pub actions: Vec<ActionDecl>,
    pub device_actions: Vec<DeviceActionDecl>,
    pub signals: Vec<SignalDecl>,
    pub settings: Vec<SettingDecl>,
    pub choices: Vec<ChoicesDecl>,
    pub permissions: Vec<PermissionDecl>,
}

Everything static about an addon.

Fields

id: String

Stable identifier, stored in bindings.

name: String

What to call it.

description: String

What it integrates, in a sentence.

actions: Vec<ActionDecl>

Everything it can be asked to do.

device_actions: Vec<DeviceActionDecl>

Everything it names that the device does on its own (ADR-0021).

Omitted when empty, which is almost always, and the omission is load-bearing in the same way permissions’ is: an addon built against SDK 1.0 sends no field, and declares none is exactly the right reading of that. The reverse — a 1.1 addon talking to a 1.0 daemon — is the case the version number cannot express, and is answered in run rather than here.

signals: Vec<SignalDecl>

Everything it publishes.

settings: Vec<SettingDecl>

Everything it needs configuring.

choices: Vec<ChoicesDecl>

Named lists its parameters draw options from (ADR-0022).

Omitted when empty, which is every addon that has none — and an addon built against an older SDK sends no field, which reads correctly as “declares none”.

permissions: Vec<PermissionDecl>

Everything it needs to be allowed to do (FR-046).

Omitted when empty, which is the ordinary case — and the omission is load-bearing rather than tidy: an addon built against an older SDK sends no field, and “declares nothing” is exactly the right reading of that.

Trait Implementations

impl Clone for Description

fn clone(&self) -> Description

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Description

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Description

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Description

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

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 Description

impl StructuralPartialEq for Description