Enum KeyBindingContextPredicate 

pub enum KeyBindingContextPredicate {
    Identifier(SharedString),
    Equal(SharedString, SharedString),
    NotEqual(SharedString, SharedString),
    Descendant(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>),
    Not(Box<KeyBindingContextPredicate>),
    And(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>),
    Or(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>),
}

A datastructure for resolving whether an action should be dispatched Representing a small language for describing which contexts correspond to which actions.

Variants

Identifier(SharedString)

A predicate that will match a given identifier.

Equal(SharedString, SharedString)

A predicate that will match a given key-value pair.

NotEqual(SharedString, SharedString)

A predicate that will match a given key-value pair not being present.

Descendant(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>)

A predicate that will match a given predicate appearing below another predicate. in the element tree

Not(Box<KeyBindingContextPredicate>)

Predicate that will invert another predicate.

And(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>)

A predicate that will match if both of its children match.

Or(Box<KeyBindingContextPredicate>, Box<KeyBindingContextPredicate>)

A predicate that will match if either of its children match.

Implementations

impl KeyBindingContextPredicate

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

Parse a string in the same format as the keymap’s context field.

A basic equivalence check against a set of identifiers can performed by simply writing a string:

StatusBar -> A predicate that will match a context with the identifier StatusBar

You can also specify a key-value pair:

mode == visible -> A predicate that will match a context with the key mode with the value visible

And a logical operations combining these two checks:

StatusBar && mode == visible -> A predicate that will match a context with the identifier StatusBar and the key mode with the value visible

There is also a special child > operator that will match a predicate that is below another predicate:

StatusBar > mode == visible -> A predicate that will match a context identifier StatusBar and a child context that has the key mode with the value visible

This syntax supports !=, || and && as logical operators. You can also preface an operation or check with a ! to negate it.

pub fn depth_of(&self, contexts: &[KeyContext]) -> Option<usize>

Find the deepest depth at which the predicate matches.

pub fn eval_inner( &self, contexts: &[KeyContext], all_contexts: &[KeyContext], ) -> bool

Eval a predicate against a set of contexts, arranged from lowest to highest.

pub fn is_superset(&self, other: &Self) -> bool

Returns whether or not this predicate matches all possible contexts matched by the other predicate.

Trait Implementations

impl Clone for KeyBindingContextPredicate

fn clone(&self) -> KeyBindingContextPredicate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBindingContextPredicate

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

Formats the value using the given formatter.

impl Display for KeyBindingContextPredicate

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

Formats the value using the given formatter.

impl Hash for KeyBindingContextPredicate

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 KeyBindingContextPredicate

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

impl StructuralPartialEq for KeyBindingContextPredicate