Struct Keymap 

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

Wrapper of Vec<Key>.

This only has parse func, please use as_vec to access to inner.

Example

use viks::Keymap;

let exit_map = Keymap::new("ZZ").unwrap();
let exit_map_alt = Keymap::new("<s-z>Z").unwrap();

assert_eq!(exit_map, exit_map_alt);

Implementations

impl Keymap

pub fn new(s: &str) -> Result<Self>

Create new Keymap.

Example

use viks::Keymap;

let exit_map = Keymap::new("ZZ").unwrap();
let exit_map_alt = Keymap::new("<s-z>Z").unwrap();

assert_eq!(exit_map, exit_map_alt);

Error

Returns an error if the tag is not closed.

pub fn as_vec(&self) -> &Vec<Key>

Get inner ref.

Example

use viks::Keymap;

let keymap = Keymap::new("ZZ").unwrap();

for key in keymap.as_vec().iter() {
    // ..
}

Trait Implementations

impl Clone for Keymap

fn clone(&self) -> Keymap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keymap

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Keymap

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Keymap

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

Formats the value using the given formatter.

impl From<Vec<Key>> for Keymap

fn from(value: Vec<Key>) -> Self

Converts to this type from the input type.

impl Hash for Keymap

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 Ord for Keymap

fn cmp(&self, other: &Keymap) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Keymap

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

fn partial_cmp(&self, other: &Keymap) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Keymap

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Keymap

impl StructuralPartialEq for Keymap