Struct ActionState 

pub struct ActionState {
    pub badge: Option<String>,
    pub toggles: bool,
    pub shortcut: Option<String>,
}

What an action’s row shows of the state the action acts on, beside its label: data, never drawing code. Every surface that lists the action (the palette, a menu, an agent’s listing) reads the same.

Fields

badge: Option<String>

A short live status (“On”, “Current”).

toggles: bool

The action flips the state its badge shows, so choosing it keeps the list it was chosen from open on the new state.

shortcut: Option<String>

The keys that do the same, spelled as the keyboard layout in use reads them.

Implementations

impl ActionState

pub const MAX_BADGE_BYTES: usize = ResourcePresentation::MAX_BADGE_BYTES

pub fn is_empty(&self) -> bool

Nothing to show.

pub fn badge(badge: impl Into<String>) -> ActionState

A row showing badge.

Trait Implementations

impl Clone for ActionState

fn clone(&self) -> ActionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionState

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

Formats the value using the given formatter.

impl Default for ActionState

fn default() -> ActionState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ActionState

where ActionState: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ActionState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ActionState

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ActionState

impl StructuralPartialEq for ActionState