Struct AddonChoices 

pub struct AddonChoices {
    pub id: &'static str,
    pub name: &'static str,
    pub live: bool,
    pub values: &'static [AddonChoice],
}

A named list of options an addon offers, which a parameter can draw from.

ADR-0022. Named rather than attached to one parameter, and the third reason below is the one that decided it:

• a live fetch is then one addon and one id, where a parameter would need (addon, action, param) — and a setting’s parameter has no action;
• two parameters can share one list, so a pin and a priority pointing at the same people cannot show two different rosters;
• composition belongs to the addon. 006-FR-011b wants the current call, then people remembered from previous calls, then free text — an ordering that is Discord’s business. With a named source the addon returns one flat ordered list and the interface renders it, so “remembered people” needs no interface support at all.

Fields

id: &'static str

Stable id, unique within the addon. A parameter names this.

name: &'static str

What the list is, for the editor’s heading and its empty state.

live: bool

Whether the values must be asked for rather than read from below.

A declared source is fixed for the life of the daemon and arrives with everything else. A live one changes — a voice roster, the playlists on an account — and is fetched when somebody opens the picker and at no other time. Not polled: a timer would cost idle CPU for a picker nobody has open, which 006-FR-027 forbids and 006-SC-008 measures.

values: &'static [AddonChoice]

Every value, for a declared source. Empty when Self::live.

Trait Implementations

impl Clone for AddonChoices

fn clone(&self) -> AddonChoices

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddonChoices

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

Formats the value using the given formatter.

impl PartialEq for AddonChoices

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

impl Eq for AddonChoices

impl StructuralPartialEq for AddonChoices