Struct Binding 

pub struct Binding { /* private fields */ }

A keybinding with associated help text.

Bindings can be enabled/disabled and contain zero or more key sequences that trigger the binding.

Implementations

impl Binding

pub fn new() -> Self

Creates a new empty binding.

pub fn keys(self, keys: &[&str]) -> Self

Sets the keys for this binding.

Example

use bubbles::key::Binding;

let binding = Binding::new().keys(&["k", "up", "ctrl+p"]);
assert_eq!(binding.get_keys(), &["k", "up", "ctrl+p"]);

pub fn help(self, key: impl Into<String>, desc: impl Into<String>) -> Self

Sets the help text for this binding.

Example

use bubbles::key::Binding;

let binding = Binding::new()
    .keys(&["q"])
    .help("q", "quit");
assert_eq!(binding.get_help().key, "q");
assert_eq!(binding.get_help().desc, "quit");

pub fn disabled(self) -> Self

Creates a disabled binding.

pub fn set_keys(&mut self, keys: &[&str])

Sets the keys for this binding (mutable version).

pub fn get_keys(&self) -> &[String]

Returns the keys for this binding.

pub fn set_help(&mut self, key: impl Into<String>, desc: impl Into<String>)

Sets the help text for this binding (mutable version).

pub fn get_help(&self) -> &Help

Returns the help information for this binding.

pub fn enabled(&self) -> bool

Returns whether this binding is enabled.

A binding is enabled if it’s not explicitly disabled and has at least one key.

pub fn enable(&mut self, enabled: bool)

Enables or disables the binding (mutable version).

pub fn set_enabled(self, enabled: bool) -> Self

Enables or disables the binding (builder version).

pub fn unbind(&mut self)

Removes the keys and help from this binding, effectively nullifying it.

This is a step beyond disabling - it removes the binding entirely. Use this when you want to completely remove a keybinding from a keymap.

Trait Implementations

impl Clone for Binding

fn clone(&self) -> Binding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Binding

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

Formats the value using the given formatter.

impl Default for Binding

fn default() -> Binding

Returns the “default value” for a type.