Struct Overrides 

pub struct Overrides { /* private fields */ }

Keys rebound by context.action: what a configuration file sets.

Implementations

impl Overrides

pub fn new() -> Overrides

pub fn set( &mut self, context: &str, action: &str, keys: impl IntoIterator<Item = Key>, ) -> &mut Self

Make keys do context.action. No keys unbinds it.

pub fn get(&self, id: &str) -> Option<&[Key]>

The keys set for context.action, if any.

pub fn is_empty(&self) -> bool

pub fn from_pairs<I, A, K>(pairs: I) -> Result<Overrides, String>

where I: IntoIterator<Item = (A, K)>, A: AsRef<str>, K: AsRef<str>,

(context.action, keys) pairs, as a configuration table holds them ("select.down" = "ctrl+n, down").

pub fn parse(text: &str) -> Result<Overrides, String>

One context.action = key, key per line; blank lines are skipped, and # at the start of a line or after a space starts a comment (ctrl+# is a key). Quote a key that is a separator or a comment: "#", ",". none unbinds the action; a line with no keys is an error, so a stray # or , never unbinds one by accident.

use rich_interact::keymap::Overrides;
use rich_interact::Key;

let overrides = Overrides::parse("select.down = \"#\" j # keys\nselect.up = none").unwrap();
assert_eq!(overrides.get("select.down").unwrap(), [Key::char('#'), Key::char('j')]);
assert_eq!(overrides.get("select.up").unwrap(), []);
assert!(Overrides::parse("select.down = #").is_err());

Trait Implementations

impl Clone for Overrides

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Overrides

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

Formats the value using the given formatter.

impl Default for Overrides

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Overrides

impl PartialEq for Overrides

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Overrides