Struct keynergy::layout::Keys

pub struct Keys {
    pub matrix: Vec<Vec<char>>,
    pub map: HashMap<char, Pos>,
    pub home_row: u8,
    pub thumb_row: Option<u8>,
}

Fields

matrix: Vec<Vec<char>>

map: HashMap<char, Pos>

home_row: u8

thumb_row: Option<u8>

Implementations

impl Keys

pub fn new(matrix: Vec<Vec<char>>, home_row: u8, thumb_row: Option<u8>) -> Self

pub fn fill_map(&mut self)

impl Keys

pub fn qwerty() -> Self

pub fn has_pos(&self, p: Pos) -> bool

Returns whether the keys contain a character or not.

Example

use keynergy::{Keys, Pos};
let qwerty = Keys::qwerty();
assert_eq!(qwerty.has_pos(Pos::new(0,0)), true);
assert_eq!(qwerty.has_pos(Pos::new(100,4)), false);

pub fn pos_key_unsafe(&self, p: Pos) -> &char

Returns the character at the given position without checking if it’s valid.

Examples

use keynergy::{Keys, Pos};
let qwerty = Keys::qwerty();
assert_eq!(qwerty.pos_key_unsafe(Pos::new(0,0)), &'q');

This example panics

use keynergy::{Keys, Pos};
let qwerty = Keys::qwerty();
let c = qwerty.pos_key_unsafe(Pos::new(100, 0));

pub fn pos_key(&self, p: Pos) -> Option<&char>

pub fn swap(&mut self, a: Pos, b: Pos)

Trait Implementations

impl Clone for Keys

fn clone(&self) -> Keys

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Keys

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Keys

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Keys

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.