Skip to main content

Fork

Struct Fork 

Source
pub struct Fork {
    pub trigger: KeyAction,
    pub negative_output: KeyAction,
    pub positive_output: KeyAction,
    pub match_any: StateBits,
    pub match_none: StateBits,
    pub kept_modifiers: ModifierCombination,
    pub bindable: bool,
}
Expand description

Fork (key override) configuration.

A fork overrides a key’s output based on the current modifier/LED/mouse state. When the trigger key is pressed, the fork checks current state against match_any and match_none to decide between positive_output and negative_output.

Fields§

§trigger: KeyAction

The key action that activates this fork. Should not be KeyAction::Transparent.

§negative_output: KeyAction

Output when the state condition is NOT met.

§positive_output: KeyAction

Output when the state condition IS met.

§match_any: StateBits

If any of these state bits are active, the positive branch is taken.

§match_none: StateBits

If any of these state bits are active, the fork is suppressed.

§kept_modifiers: ModifierCombination

Modifiers to keep active when the fork fires.

§bindable: bool

Whether this fork can be rebound via protocol. This is a firmware-enforced policy — the protocol itself does not reject writes to non-bindable forks; enforcement happens in the firmware’s SetFork handler.

Implementations§

Source§

impl Fork

Source

pub fn new( trigger: KeyAction, negative_output: KeyAction, positive_output: KeyAction, match_any: StateBits, match_none: StateBits, kept_modifiers: ModifierCombination, bindable: bool, ) -> Self

Source

pub fn empty() -> Self

Trait Implementations§

Source§

impl Clone for Fork

Source§

fn clone(&self) -> Fork

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Fork

Source§

impl Debug for Fork

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Fork

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Fork

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Fork

Source§

impl MaxSize for Fork

Source§

const POSTCARD_MAX_SIZE: usize

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

impl PartialEq for Fork

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Fork

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Fork

Auto Trait Implementations§

§

impl Freeze for Fork

§

impl RefUnwindSafe for Fork

§

impl Send for Fork

§

impl Sync for Fork

§

impl Unpin for Fork

§

impl UnsafeUnpin for Fork

§

impl UnwindSafe for Fork

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.