Enum Event

pub enum Event {
    FocusGained,
    FocusLost,
    Key(KeyEvent),
    Mouse(MouseEvent),
    Paste(String),
    Resize {
        rows: u32,
        cols: u32,
    },
}

An application event.

Variants

FocusGained

The application gained focus.

FocusLost

The application lost focus.

Key(KeyEvent)

A keyboard input event.

Mouse(MouseEvent)

A mouse input event.

Paste(String)

A string that was pasted into the application.

Resize

An resize event with new dimensions after resize.

Fields

rows: u32

New number of rows.

cols: u32

New number of columns.

Implementations

impl Event

pub fn encode(&self, buf: &mut [u8], encoding: Encoding) -> Result<usize>

Encode the event into the given buffer using the supplied Encoding mode. Returns the number of bytes written, following the semantics of std::io::Write::write.

The supplied buffer needs enough space to hold the encoded sequence. If you’re unsure of how large the result will be, 16 bytes is more than sufficient.

Example

use terminput::{Encoding, Event, KeyCode, KeyEvent};

let event = Event::Key(KeyEvent::new(KeyCode::Char('a')));
let mut buf = [0; 16];
let written = event.encode(&mut buf, Encoding::Xterm);
if let Ok(written) = written {
    println!("Encoded: {:?}", &buf[..written]);
}

impl Event

pub fn parse_from(buffer: &[u8]) -> Result<Option<Self>>

Attempts to parse a byte sequence into an input event. Supports both the legacy Xterm input protocol and the newer enhanced protocols from fixterms and Kitty.

Returns None if the input could be a valid event, but is incomplete.

Returns an io::Error if the input cannot be parsed into a valid event.

impl Event

pub fn as_key(&self) -> Option<KeyEvent>

Returns the contained event if this is a KeyEvent.

pub fn is_key(&self) -> bool

Returns whether the event is a KeyEvent.

pub fn as_key_press(&self, repeats: Repeats) -> Option<KeyEvent>

Returns the contained event if it is a key press event.

If Repeats::Include is passed, both KeyEventKind::Press and KeyEventKind::Repeat are considered press events.

If Repeats::Exclude is passed, only KeyEventKind::Press is considered.

pub fn is_key_press(&self, repeats: Repeats) -> bool

Returns whether the contained event is a key press event.

If Repeats::Include is passed, both KeyEventKind::Press and KeyEventKind::Repeat are considered press events.

If Repeats::Exclude is passed, only KeyEventKind::Press is considered.

pub fn as_key_repeat(&self) -> Option<KeyEvent>

Returns the contained event if it is a KeyEventKind::Repeat key event.

pub fn is_key_repeat(&self) -> bool

Returns whether the contained event is a KeyEventKind::Repeat key event.

pub fn as_key_release(&self) -> Option<KeyEvent>

Returns the contained event if it is a KeyEventKind::Release key event.

pub fn is_key_release(&self) -> bool

Returns whether the contained event is a KeyEventKind::Release key event.

pub fn as_mouse(&self) -> Option<MouseEvent>

Returns the contained event if it is a MouseEvent.

pub fn is_mouse(&self) -> bool

Returns whether the contained event is a MouseEvent.

pub fn as_mouse_down(&self) -> Option<(MouseEvent, MouseButton)>

Returns the contained event if it is a MouseEventKind::Down mouse event.

pub fn is_mouse_down(&self) -> bool

Returns whether the event is a MouseEventKind::Down mouse event.

pub fn as_mouse_up(&self) -> Option<(MouseEvent, MouseButton)>

Returns the contained event if it is a MouseEventKind::Up mouse event.

pub fn is_mouse_up(&self) -> bool

Returns whether the event is a MouseEventKind::Up mouse event.

pub fn as_mouse_drag(&self) -> Option<(MouseEvent, MouseButton)>

Returns the contained event if it is a MouseEventKind::Drag mouse event.

pub fn is_mouse_drag(&self) -> bool

Returns whether the event is a MouseEventKind::Drag mouse event.

pub fn as_mouse_move(&self) -> Option<MouseEvent>

Returns the contained event if it is a MouseEventKind::Moved mouse event.

pub fn is_mouse_move(&self) -> bool

Returns whether the event is a MouseEventKind::Moved mouse event.

pub fn as_mouse_scroll(&self) -> Option<(MouseEvent, ScrollDirection)>

Returns the contained event if it is a MouseEventKind::Scroll mouse event.

pub fn is_mouse_scroll(&self) -> bool

Returns whether the event is a MouseEventKind::Scroll mouse event.

pub fn is_focus_gained(&self) -> bool

Returns whether the event is Event::FocusGained.

pub fn is_focus_lost(&self) -> bool

Returns whether the event is Event::FocusLost.

pub fn as_paste(&self) -> Option<&str>

Returns the pasted text if the event is Event::Paste.

pub fn is_paste(&self) -> bool

Returns whether the event is Event::Paste.

pub fn as_resize(&self) -> Option<(u32, u32)>

Returns the (rows, cols) from the contained event if it is a Event::Resize event.

pub fn is_resize(&self) -> bool

Returns whether the event is Event::Resize.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Event

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Event

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Event

fn partial_cmp(&self, other: &Event) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Event

impl StructuralPartialEq for Event