Enum streampager::bindings::Binding

pub enum Binding {
    Action(Action),
    Custom(CustomBinding),
    Unrecognized(String),
}

An action that may be bound to a key.

Variants

Action(Action)

An action.

Custom(CustomBinding)

A custom binding.

Unrecognized(String)

An unrecognised binding.

Implementations

impl Binding

pub fn custom(
    category: Category,
    description: impl Into<String>,
    callback: impl Fn(FileIndex) + Send + Sync + 'static
) -> Self

Create new custom binding.

When this binding is invoked, the callback is called. The callback is provided with the file index of the file that is currently being displayed. Note that this may differ from any of the file indexes returned by the add methods on the Pager, as additional file indexes can be allocated, e.g. for the help screen.

pub fn parse(ident: String, params: Vec<String>) -> Result<Self, BindingError>

Parse a keybinding identifier and list of parameters into a key binding.

Trait Implementations

impl Clone for Binding

fn clone(&self) -> Binding

Returns a copy of the value.

pub 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 Display for Binding

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

Formats the value using the given formatter.

impl Eq for Binding

impl From<Action> for Binding

fn from(action: Action) -> Binding

Performs the conversion.

impl Hash for Binding

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Binding> for Binding

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Binding

impl StructuralPartialEq for Binding