Enum surf_n_term::terminal::TerminalCommand

pub enum TerminalCommand {
    Char(char),
    Face(Face),
    DecModeSet {
        enable: bool,
        mode: DecMode,
    },
    DecModeGet(DecMode),
    CursorGet,
    CursorTo(Position),
    CursorSave,
    CursorRestore,
    EraseLineLeft,
    EraseLineRight,
    EraseLine,
    EraseChars(usize),
    Scroll(i32),
    ScrollRegion {
        start: usize,
        end: usize,
    },
    Reset,
    Image(Image),
    ImageErase(Position),
    Termcap(Vec<String>),
    Color {
        name: TerminalColor,
        color: Option<RGBA>,
    },
    Title(String),
}

Commands that can be executed by terminal

Variants

Char(char)

Put character

Face(Face)

Set current face (foreground/background colors and text attributes)

DecModeSet

Control specified DEC mode (DECSET|DECRST)

Fields of DecModeSet

enable: boolmode: DecMode

DecModeGet(DecMode)

Report specified DEC mode (DECRQM)

CursorGet

Request current cursor postion

CursorTo(Position)

Move cursor to specified row and column

CursorSave

Save current cursor position

CursorRestore

Restore previously saved cursor position

EraseLineLeft

Erase line using current background color to the left of the cursor

EraseLineRight

Erase line using current background color to the right of the cursor

EraseLine

Erase line using current background color

EraseChars(usize)

Erase specified ammount of characters to the right from current cursor position

Scroll(i32)

Scroll, positive is up and negative is down

ScrollRegion

Set scroll region

Fields of ScrollRegion

start: usizeend: usize

Reset

Full reset of the terminal

Image(Image)

Draw image

ImageErase(Position)

Erase image

Termcap(Vec<String>)

Request Termcap/Terminfo XTGETTCAP

Color

Set or query terminal colors

Fields of Color

name: TerminalColorcolor: Option<RGBA>

Title(String)

Trait Implementations

impl Clone for TerminalCommand

fn clone(&self) -> TerminalCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalCommand

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

Formats the value using the given formatter.

impl Hash for TerminalCommand

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 TerminalCommand

fn cmp(&self, other: &TerminalCommand) -> 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<TerminalCommand> for TerminalCommand

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

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

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

This method tests for !=.

impl PartialOrd<TerminalCommand> for TerminalCommand

fn partial_cmp(&self, other: &TerminalCommand) -> 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 TerminalCommand

impl StructuralEq for TerminalCommand

impl StructuralPartialEq for TerminalCommand