Enum KeyboardType

pub enum KeyboardType {
    Ansi,
    Iso,
    Ortho,
    Colstag,
    Custom(String),
}

Some default form factors. Options are Ansi, Iso, Ortho (being 3x10 + 3 thumb keys per thumb), Colstag (being 3x10 + 3 thumb keys per thumb) and a custom option if any anything but the prior options is provided.

Variants

Ansi

Iso

Ortho

Colstag

Custom(String)

Implementations

impl KeyboardType

pub fn shape(&self) -> Shape

Get the shape of a certain keyboard type.

pub fn fingering( &self, named_fingering: &NamedFingering, ) -> Result<Fingering, DofError>

Given a known fingering from NamedFingering, provide a Fingering object with all keys on a board like that specified. Will Return an error if any combination is provided that isn’t valid, like KeyboardType::Ortho and NamedFingering::Angle.

pub const fn is_custom(&self) -> bool

Checks if the keyboard is Custom.

pub const fn anchor(&self) -> Anchor

Get the default anchor for each keyboard type. This is (1, 1) for Ansi and Iso boards (as the vast majority of keyboard layouts doesn’t remap the number row or special keys on the left) and (0, 0) for the rest.

Trait Implementations

impl Clone for KeyboardType

fn clone(&self) -> KeyboardType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardType

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

Formats the value using the given formatter.

impl Display for KeyboardType

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

Formats the value using the given formatter.

impl FromStr for KeyboardType

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KeyboardType

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 PartialEq for KeyboardType

fn eq(&self, other: &KeyboardType) -> 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 TryFrom<KeyboardType> for PhysicalKeyboard

type Error = DofError

The type returned in the event of a conversion error.

fn try_from(board: KeyboardType) -> Result<Self, DofError>

Performs the conversion.

impl Eq for KeyboardType

impl StructuralPartialEq for KeyboardType