Struct MorseProfile 

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

Configuration for morse, tap dance and tap-hold. Manually packed into 64 bits to save RAM.

Bit layout of the inner u64:

63        46 | 45      | 44           32 | 31  30 | 29       17 | 16  15 | 14  13   | 12       0
reserved     | qt_set  | quick_tap_tm    | mode   | gap_timeout | uni_tap| flow_tap | hold_timeout
  (18b)      |  (1b)   |   (13b ms)      |  (2b)  |   (13b ms)  |  (2b)  |   (2b)   |  (13b ms)

• qt_set (bit 45): when set, quick_tap_timeout is explicitly configured (even if 0, which means “disabled”). When clear, the field is unset and callers should fall back to the global default.
• quick_tap_timeout (bits 44-32): quick-tap timeout in ms (max 8191).
• mode (bits 31-30): 00 = None, 01 = PermissiveHold, 10 = HoldOnOtherPress, 11 = Normal
• flow_tap (bits 14, 13): 00/01 = None, 10 = Some(false), 11 = Some(true)
• gap_timeout (bits 29-17): gap timeout in ms (0 = None, max 8191)
• uni_tap (bits 16-15): 00/01 = None, 10 = Some(false), 11 = Some(true)
• hold_timeout (bits 12-0): hold timeout in ms (0 = None, max 8191)

Implementations

impl MorseProfile

pub const fn const_default() -> Self

pub fn unilateral_tap(self) -> Option<bool>

If the previous key is on the same “hand”, the current key will be determined as a tap

pub const fn with_unilateral_tap(self, b: Option<bool>) -> Self

pub fn enable_flow_tap(self) -> Option<bool>

Per-profile override for flow tap. None inherits the global morse setting.

pub const fn with_enable_flow_tap(self, b: Option<bool>) -> Self

pub fn mode(self) -> Option<MorseMode>

The decision mode of the morse/tap-hold key

pub const fn with_mode(self, m: Option<MorseMode>) -> Self

pub fn hold_timeout_ms(self) -> Option<u16>

If the key is pressed longer than this, it is accepted as hold (in milliseconds)

pub const fn with_hold_timeout_ms(self, t: Option<u16>) -> Self

pub const fn set_hold_timeout_ms(&mut self, t: u16)

pub const fn set_gap_timeout_ms(&mut self, t: u16)

pub fn gap_timeout_ms(self) -> Option<u16>

The time elapsed from the last release of a key is longer than this, it will break the morse pattern (in milliseconds)

pub const fn with_gap_timeout_ms(self, t: Option<u16>) -> Self

pub const fn quick_tap_timeout_ms(self) -> Option<u16>

pub const fn with_quick_tap_timeout_ms(self, t: Option<u16>) -> Self

pub const fn set_quick_tap_timeout_ms(&mut self, t: u16)

pub const fn new( unilateral_tap: Option<bool>, mode: Option<MorseMode>, hold_timeout_ms: Option<u16>, gap_timeout_ms: Option<u16>, ) -> Self

Trait Implementations

impl Clone for MorseProfile

fn clone(&self) -> MorseProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MorseProfile

impl Debug for MorseProfile

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

Formats the value using the given formatter.

impl Default for MorseProfile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MorseProfile

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

Deserialize this value from the given Serde deserializer.

impl Eq for MorseProfile

impl From<MorseProfile> for u64

fn from(val: MorseProfile) -> Self

Converts to this type from the input type.

impl From<u64> for MorseProfile

fn from(v: u64) -> Self

Converts to this type from the input type.

impl MaxSize for MorseProfile

const POSTCARD_MAX_SIZE: usize

The maximum possible size that the serialization of this type can have, in bytes.

impl PartialEq for MorseProfile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MorseProfile

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MorseProfile