Struct Input 

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

safety wrapper for SimpleTextInputExProtocol

Implementations

impl Input

pub fn reset(&mut self, extended_verification: bool) -> Result

clear keyboard cache

pub fn read_key_stroke_ex(&mut self) -> Option<KeyData>

non-blocking keyboard read

pub fn wait_for_key_event(&self) -> Option<Event>

Returns an event that is signaled when a key is pressed.

This allows the caller to wait for input without polling in a busy loop, or to use it in wait_for_event along with other events (like timers).

pub fn set_state(&mut self, state: KeyToggleState) -> Result

only set toggle state

pub fn on_key_callback( &mut self, key_data: &KeyData, notification_function: KeyNotifyFunction, ) -> Result<KeyNotifyHandle<'_>>

Register a callback function to be invoked when a key is pressed.

Usage

1. Prepare callback function

extern "efiapi" fn listener(_key_data: *mut uefi_input2::simple_text_input_ex::RawKeyData) -> Status {
    if _key_data.is_null() { return Status::INVALID_PARAMETER; }
    let data = unsafe { *_key_data };
    let data = KeyData::from(data);
    uefi::println!("{:?}{:08X}", data.key, data.key_state.key_shift_state);
    Status::SUCCESS
}

2. Register callback function

uefi_input2::with_stdin(|input| {
    let trigger_key = KeyData::new('b')?;
    let _listener = input.on_key_callback(&trigger_key, listener)?;
    loop { core::hint::spin_loop() }
    Ok(())
 }).unwrap();

pub unsafe fn register_key_notify( &mut self, key_data: &KeyData, notification_function: KeyNotifyFunction, ) -> Result<ManualKeyNotifyHandle>

Register a callback function to be invoked when a key is pressed. (need manual unregister)

pub unsafe fn unregister_key_notify( &mut self, handle: ManualKeyNotifyHandle, ) -> Result

Unregister a callback function

Trait Implementations

impl Debug for Input

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

Formats the value using the given formatter.

impl Identify for Input

const GUID: Guid = SimpleTextInputExProtocol::GUID

Unique protocol identifier.

impl Protocol for Input