Struct ShortcutConfig 

pub struct ShortcutConfig {
    pub bindings: BTreeMap<ShortcutAction, KeyChord>,
    pub actions: Vec<ActionChord>,
}

Fields

bindings: BTreeMap<ShortcutAction, KeyChord>

actions: Vec<ActionChord>

Chords bound to published actions: anything the action door offers, a saved shortcut’s run included.

Implementations

impl ShortcutConfig

pub fn validate(&self) -> Result<(), ShortcutConfigError>

Validate an already assembled table before it becomes live runtime state. Unlike Self::load, this rejects rather than repairs so a caller cannot install ambiguous ownership in a running session.

Errors

Returns an error when a chord is invalid or reserved, or when two actions claim the same chord.

pub fn check_action_chord( &self, chord: &KeyChord, target: Option<&ActionChordTarget>, ) -> Result<(), ShortcutConfigError>

Whether chord may run the published action target: a valid, unreserved chord that is neither one of the shell’s fixed chords, nor bound to a configurable desktop action, nor running another action.

pub fn set_action( &mut self, chord: KeyChord, target: ActionChordTarget, label: impl Into<String>, ) -> Result<(), ShortcutConfigError>

Bind chord to the published action target, replacing the chord it had.

Errors

Why the chord cannot be bound; the table is then unchanged.

pub fn remove_action(&mut self, target: &ActionChordTarget) -> bool

Unbind whatever chord runs target. false when none did.

pub fn action_for(&self, chord: &KeyChord) -> Option<&ActionChord>

The action chord runs, when it runs one.

pub fn set( &mut self, action: ShortcutAction, chord: KeyChord, ) -> Result<(), ShortcutConfigError>

Move action to chord. A chord that already belongs to someone else is refused, naming the holder, rather than taken from it.

Errors

Returns an error without changing this binding when chord is invalid, system-reserved, or already belongs to another action, to a fixed desktop shortcut (other than one action shares by default), or to a published action.

pub fn load() -> ShortcutConfig

pub fn load_in(source: &dyn SettingsSource) -> ShortcutConfig

Self::load from source.

pub fn from_section(section: Map<String, Value>) -> ShortcutConfig

The configuration a shortcuts section holds, repaired as Self::normalise repairs it.

pub fn normalise(loaded: ShortcutConfig) -> ShortcutConfig

Deterministically repairs manual/corrupt persisted state: begin with defaults, then accept a stored override only when it is a valid, non-reserved, non-conflicting chord. Bad entries fall back to their default instead of leaving ambiguous client ownership.

A stored chord that was once the default for its action (RETIRED_DEFAULTS) was saved because Self::save writes the whole table, not because the person chose it; it yields to the current default.

pub fn save(&self) -> Result<(), Error>

Errors

Returns an error if self can’t be serialised or the section can’t be written.

pub fn save_in(&self, source: &dyn SettingsSource) -> Result<(), Error>

Self::save into source.

pub fn section(&self) -> Result<Map<String, Value>, Error>

The shortcuts section holding this configuration.

impl ShortcutConfig

pub fn reset( &mut self, action: ShortcutAction, ) -> Result<(), ShortcutConfigError>

Put action back on its default chord.

Errors

The same refusals as Self::set: another action or a published action holds the default now, and keeps it. The table is then unchanged.

pub fn reset_all(&mut self) -> Result<(), ShortcutConfigError>

Put every desktop action back on its default chord. Chords bound to published actions stay as they are.

Errors

[ShortcutConfigError::TakenByAction] when a published action now holds one of the defaults; the table is then unchanged.

Trait Implementations

impl Clone for ShortcutConfig

fn clone(&self) -> ShortcutConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShortcutConfig

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

Formats the value using the given formatter.

impl Default for ShortcutConfig

fn default() -> ShortcutConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShortcutConfig

where ShortcutConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShortcutConfig

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

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 ShortcutConfig

impl StructuralPartialEq for ShortcutConfig