Struct libdof::DescriptiveKey

pub struct DescriptiveKey { /* private fields */ }

A Key with metadata attached. These are produced by calling Dof::keys().

Implementations

impl DescriptiveKey

pub fn new( output: Key, layer: String, row: usize, col: usize, finger: Finger ) -> Self

pub fn keypos(&self) -> KeyPos

Get the KeyPos of a certain key, containing the layer name as well its row and column coordinates.

pub fn pos(&self) -> Pos

Get the key’s row and column.

pub fn row(&self) -> usize

Get the key’s row.

pub fn col(&self) -> usize

Get the key’s column.

pub fn finger(&self) -> Finger

Get the finger the key is supposed to be pressed with.

pub fn output(&self) -> &Key

Get the key’s output.

pub fn layer_name(&self) -> &str

Get the name of the layer of the key.

pub fn is_on_finger(&self, finger: Finger) -> bool

Check if the key is on a certain finger.

pub fn is_on_fingers(&self, fingers: &[Finger]) -> bool

Check if the key is on any of the provided fingers.

pub fn is_on_left_hand(&self) -> bool

Check if the key is on left hand, including left thumb.

pub fn is_on_layer(&self, layer: &str) -> bool

Check if the key is on a specific layer.

pub fn is_char_key(&self) -> bool

Check if the key is of type Key::Char which outputs a single character.

pub fn is_word_key(&self) -> bool

Check if the key is of type Key::Word which outputs a specific string.

pub fn is_empty_key(&self) -> bool

Check if the key is of type Key::Empty which doesn’t output anything.

pub fn is_transparent_key(&self) -> bool

Check if the key is of type Key::Transparent which outputs whatever it is the main layer outputs in that position.

pub fn is_layer_key(&self) -> bool

Check if the key is of type Key::Layer which holds the name. of a layer on the layout

pub fn char_output(&self) -> Option<char>

Get the output if the key is of type Key::Char.

pub fn word_output(&self) -> Option<&str>

Get the output if the key is of type Key::Word.

pub fn layer_output(&self) -> Option<&str>

Get the layer name if the key is of type Key::Layer.

Trait Implementations

impl Clone for DescriptiveKey

fn clone(&self) -> DescriptiveKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptiveKey

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

Formats the value using the given formatter.

impl PartialEq for DescriptiveKey

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescriptiveKey