Struct libdof::Dof

pub struct Dof { /* private fields */ }

Implementations

impl Dof

pub fn get(&self, key: impl Into<Key>) -> Vec<KeyPos>

pub fn tower(&self, pos: impl Into<Pos>) -> Vec<Key>

pub fn finger(&self, pos: impl Into<Pos>) -> Option<Finger>

pub fn swap( &mut self, keypos1: impl Into<KeyPos>, keypos2: impl Into<KeyPos> ) -> Result<(), DofInteractionError>

very bulky way to swap two keys on a layout. Do not use this anywhere where performance is even remotely important.

impl Dof

pub fn name(&self) -> &str

pub fn authors(&self) -> Option<&Vec<String>>

pub fn board(&self) -> &KeyboardType

pub fn year(&self) -> Option<u32>

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

pub fn languages(&self) -> &[Language]

pub fn layers(&self) -> &BTreeMap<String, Layer>

pub fn anchor(&self) -> Anchor

pub fn fingering(&self) -> &Fingering

pub fn fingering_name(&self) -> Option<&NamedFingering>

pub fn main_layer(&self) -> Option<&Layer>

This function can be assumed to be infallible if you serialized into Dof as validation will have prevented you to create a Dof without a shift layer

pub fn shift_layer(&self) -> Option<&Layer>

This function can be assumed to be infallible if you serialized into Dof as validation will have prevented you to create a Dof without a shift layer

pub fn layer(&self, name: &str) -> Option<&Layer>

pub fn keys(&self) -> Vec<DescriptiveKey>

Trait Implementations

impl Clone for Dof

fn clone(&self) -> Dof

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dof

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dof

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Dof> for DofIntermediate

fn from(dof: Dof) -> DofIntermediate

Converts to this type from the input type.

impl PartialEq for Dof

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DofIntermediate> for Dof

type Error = DofError

The type returned in the event of a conversion error.

fn try_from(inter: DofIntermediate) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Dof