Struct AddonParam 

pub struct AddonParam {
    pub id: &'static str,
    pub name: &'static str,
    pub description: &'static str,
    pub kind: ParamKind,
    pub required: bool,
    pub multiple: bool,
    pub choices: Option<&'static str>,
}

One thing an action needs to know, declared so an interface can ask for it.

The point of declaring rather than parsing a free-text argument: FR-048 wants addon configuration built from the shared component library, and there has to be something to build it from. A third-party addon gets the same editor as a first-party one with no code in the interface.

Fields

id: &'static str

Stable identifier, and the key a binding stores it under. Renaming one silently drops whatever the user had chosen.

name: &'static str

What to call it.

description: &'static str

What it is for, in a sentence.

kind: ParamKind

What it holds.

required: bool

Whether the action can run without it.

An optional parameter is a real thing rather than an oversight: the media addon’s target application is absent for “whatever is playing”, which is the behaviour most people want most of the time.

multiple: bool

Whether it holds several values rather than one (006-FR-024a-i).

Orthogonal to Self::kind on purpose. What a value means and how many of them there are are different questions, and folding one into the other is what produces AppList, ParticipantList, PlaylistList — one new kind every time somebody wants a list of something.

choices: Option<&'static str>

The id of an AddonChoices this draws its options from, if any.

None is free text, which is what every parameter was before ADR-0022 and what a choice-backed one degrades to when its list is unavailable.

Implementations

impl AddonParam

pub const BASE: Self

A parameter with nothing set, to build from.

Exists so the next field added here does not break every const array an addon writes: AddonParam { id: "app", ..AddonParam::BASE } compiles in a const, and adding a field to BASE costs its authors nothing. It does not save the arrays that already name every field, which is why the ones in this repository were converted when this was added.

Trait Implementations

impl Clone for AddonParam

fn clone(&self) -> AddonParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddonParam

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

Formats the value using the given formatter.

impl PartialEq for AddonParam

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

impl Eq for AddonParam

impl StructuralPartialEq for AddonParam