RKTK API Docs RKTK Home Repo
rktk::hooks::interface::master

Trait MasterHooks

Source 
pub trait MasterHooks {
    // Provided methods
    async fn on_master_init(
        &mut self,
        _key_scanner: &mut impl KeyscanDriver,
        _mouse: Option<&mut impl MouseDriver>,
    ) { ... }
    async fn on_keyboard_event(&mut self, _event: &mut KeyChangeEvent) -> bool { ... }
    async fn on_mouse_event(&mut self, _mouse_move: &mut (i8, i8)) -> bool { ... }
    async fn on_encoder_event(
        &mut self,
        _id: &mut u8,
        _dir: &mut EncoderDirection,
    ) -> bool { ... }
    fn on_keymanager_event(&mut self, _event: OutputEvent) { ... }
    async fn on_state_update(
        &mut self,
        _state_report: &mut Report,
        _usb_reporter: &Option<impl ReporterDriver>,
        _ble_reporter: &Option<impl ReporterDriver>,
    ) -> bool { ... }
}
Expand description

Hooks called for master side

Provided Methods§

Source

async fn on_master_init( &mut self, _key_scanner: &mut impl KeyscanDriver, _mouse: Option<&mut impl MouseDriver>, )

Called after master side initialization.

Source

async fn on_keyboard_event(&mut self, _event: &mut KeyChangeEvent) -> bool

Called after keyboard event occur, before state update and report send.

§Parameters
  • events: The keyboard events.
§Returns

If false, this event will be ignored.

Source

async fn on_mouse_event(&mut self, _mouse_move: &mut (i8, i8)) -> bool

Called after mouse move event occur, before state update and report send.

§Parameters
  • mouse_move: The mouse move event. If None, no mouse move event occurred. If Some, the tuple contains the x and y offset of the mouse move event.
§Returns

If false, this event will be ignored.

Source

async fn on_encoder_event( &mut self, _id: &mut u8, _dir: &mut EncoderDirection, ) -> bool

Called after encoder event occur, before state update and report send.

§Parameters
  • id: The encoder id.
  • dir: The encoder direction.
§Returns

If false, this event will be ignored.

Source

fn on_keymanager_event(&mut self, _event: OutputEvent)

Called after keymanager event occur.

This hook can be used to handle custom keycode.

Source

async fn on_state_update( &mut self, _state_report: &mut Report, _usb_reporter: &Option<impl ReporterDriver>, _ble_reporter: &Option<impl ReporterDriver>, ) -> bool

Called after state update, before report send.

WARNING: Mutating the state_report or returning false can cause inconsistent state.

§Parameters
  • state_report: Report returned from rktk-keymanager’s update function.
§Returns

If false, this report will be ignored.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§