Struct TerminalInputCore 

pub struct TerminalInputCore {
    pub state: Arc<Mutex<TerminalInputState>>,
    pub condvar: Arc<Condvar>,
    pub stop: Arc<AtomicBool>,
    pub capturing: Arc<AtomicBool>,
    pub worker: Mutex<Option<JoinHandle<()>>>,
}

Shared native terminal input capture core.

Fields

state: Arc<Mutex<TerminalInputState>>

Shared queue and closed flag for captured input.

condvar: Arc<Condvar>

Condition variable signaled when input state changes.

stop: Arc<AtomicBool>

Stop flag observed by the capture worker.

capturing: Arc<AtomicBool>

Whether native input capture is currently active.

worker: Mutex<Option<JoinHandle<()>>>

Worker thread handle for active capture.

Implementations

impl TerminalInputCore

pub fn new() -> Self

Creates an idle terminal input core with capture stopped.

pub fn next_event(&self) -> Option<TerminalInputEventRecord>

Pops the next queued terminal input event without blocking.

pub fn available(&self) -> bool

Returns whether at least one input event is queued.

pub fn capturing(&self) -> bool

Returns whether native terminal input capture is active.

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

Returns the saved original Windows console mode, if capture is active.

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

Returns the active Windows console mode, if capture is active.

pub fn wait_for_event( &self, timeout: Option<f64>, ) -> Result<TerminalInputEventRecord, TerminalInputError>

Blocks until an input event, closure, or optional timeout.

pub fn drain_events(&self) -> Vec<TerminalInputEventRecord>

Drains all queued terminal input events.

pub fn stop_impl(&self) -> Result<(), Error>

Stops native terminal input capture and restores console state.

Trait Implementations

impl Default for TerminalInputCore

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TerminalInputCore

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.