Struct KeyContext 

pub struct KeyContext(/* private fields */);

A datastructure for resolving whether an action should be dispatched at this point in the element tree. Contains a set of identifiers and/or key value pairs representing the current context for the keymap.

Implementations

impl KeyContext

pub fn new_with_defaults() -> Self

Initialize a new KeyContext that contains an os key set to either macos, linux, windows or unknown.

pub fn primary(&self) -> Option<&ContextEntry>

Returns the primary context entry (usually the name of the component)

pub fn secondary(&self) -> impl Iterator<Item = &ContextEntry>

Returns everything except the primary context entry.

pub fn parse(source: &str) -> Result<Self>

Parse a key context from a string. The key context format is very simple:

• either a single identifier, such as StatusBar
• or a key value pair, such as mode = visible
• separated by whitespace, such as StatusBar mode = visible

pub fn is_empty(&self) -> bool

Check if this context is empty.

pub fn clear(&mut self)

Clear this context.

pub fn extend(&mut self, other: &Self)

Extend this context with another context.

pub fn add<I: Into<SharedString>>(&mut self, identifier: I)

Add an identifier to this context, if it’s not already in this context.

pub fn set<S1: Into<SharedString>, S2: Into<SharedString>>( &mut self, key: S1, value: S2, )

Set a key value pair in this context, if it’s not already set.

pub fn contains(&self, key: &str) -> bool

Check if this context contains a given identifier or key.

pub fn get(&self, key: &str) -> Option<&SharedString>

Get the associated value for a given identifier or key.

Trait Implementations

impl Clone for KeyContext

fn clone(&self) -> KeyContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyContext

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

Formats the value using the given formatter.

impl Default for KeyContext

fn default() -> KeyContext

Returns the “default value” for a type.

impl Hash for KeyContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyContext

fn eq(&self, other: &KeyContext) -> 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<'a> TryFrom<&'a str> for KeyContext

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self>

Performs the conversion.

impl Eq for KeyContext

impl StructuralPartialEq for KeyContext