Enum Action

pub enum Action {
    MoveCursorTo(u16, u16),
    HideCursor,
    ShowCursor,
    EnableBlinking,
    DisableBlinking,
    ClearTerminal(Clear),
    SetTerminalSize(u16, u16),
    ScrollUp(u16),
    ScrollDown(u16),
    EnableRawMode,
    DisableRawMode,
    EnterAlternateScreen,
    LeaveAlternateScreen,
    EnableMouseCapture,
    DisableMouseCapture,
    SetForegroundColor(Color),
    SetBackgroundColor(Color),
    SetAttribute(Attribute),
    ResetColor,
}

An action that can be performed on the terminal.

To perform an Action use Terminal::act.

Variants

MoveCursorTo(u16, u16)

Moves the terminal cursor to the given position (column, row).

HideCursor

Hides the terminal cursor.

ShowCursor

Shows the terminal cursor.

EnableBlinking

Enables blinking of the terminal cursor.

DisableBlinking

Disables blinking of the terminal cursor.

ClearTerminal(Clear)

Clears the terminal screen buffer.

SetTerminalSize(u16, u16)

Sets the terminal size (columns, rows).

ScrollUp(u16)

Scrolls the terminal screen a given number of rows up.

ScrollDown(u16)

Scrolls the terminal screen a given number of rows down.

EnableRawMode

Enables raw mode.

DisableRawMode

Disables raw mode.

EnterAlternateScreen

Switches to alternate screen.

LeaveAlternateScreen

Switches back to the main screen.

EnableMouseCapture

Enables mouse event capturing.

DisableMouseCapture

Disables mouse event capturing.

SetForegroundColor(Color)

Sets the the foreground color.

SetBackgroundColor(Color)

Sets the the background color.

SetAttribute(Attribute)

Sets an attribute.

ResetColor

Resets the colors back to default.

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl From<Action> for String

fn from(action: Action) -> Self

Converts to this type from the input type.

impl Hash for Action

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 Ord for Action

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Action

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

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

impl Eq for Action

impl StructuralPartialEq for Action