Enum surf_n_term::terminal::TerminalEvent

pub enum TerminalEvent {
    Key(Key),
    Mouse(Mouse),
    CursorPosition {
        row: usize,
        col: usize,
    },
    Resize(TerminalSize),
    Size(TerminalSize),
    DecMode {
        mode: DecMode,
        status: DecModeStatus,
    },
    KittyImage {
        id: u64,
        error: Option<String>,
    },
    Wake,
    Termcap(BTreeMap<String, Option<String>>),
    DeviceAttrs(BTreeSet<usize>),
    Raw(Vec<u8>),
    Color {
        name: TerminalColor,
        color: RGBA,
    },
    Command(TerminalCommand),
}

Events returned by terminal

Variants

Key(Key)

Key press event

Mouse(Mouse)

Mouse event

CursorPosition

Current cursor position

Fields of CursorPosition

row: usizecol: usize

Resize(TerminalSize)

Terminal was resized

Size(TerminalSize)

Current terminal size

DecMode

DEC mode status

Fields of DecMode

mode: DecModestatus: DecModeStatus

KittyImage

Kitty image result

Fields of KittyImage

id: u64error: Option<String>

Wake

Terminal have been woken by waker object

Termcap(BTreeMap<String, Option<String>>)

Termcap/Terminfo repsponse to XTGETTCAP

DeviceAttrs(BTreeSet<usize>)

Terminal Attributes DA1 response

Raw(Vec<u8>)

Unrecognized bytes (TODO: remove Vec and just use u8)

Color

Color

Fields of Color

name: TerminalColorcolor: RGBA

Command(TerminalCommand)

So we can use single decoder for commands and events

Trait Implementations

impl Clone for TerminalEvent

fn clone(&self) -> TerminalEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalEvent

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

Formats the value using the given formatter.

impl Hash for TerminalEvent

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TerminalEvent

fn cmp(&self, other: &TerminalEvent) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TerminalEvent> for TerminalEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TerminalEvent> for TerminalEvent

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Eq for TerminalEvent

impl StructuralEq for TerminalEvent

impl StructuralPartialEq for TerminalEvent