Enum ansitok::EscapeCode

#[non_exhaustive]
pub enum EscapeCode<'a> {
    CursorBackward(u32),
    CursorDown(u32),
    CursorForward(u32),
    CursorPos(u32, u32),
    CursorRestore,
    CursorSave,
    CursorToApp,
    CursorUp(u32),
    EraseDisplay,
    EraseLine,
    Escape,
    HideCursor,
    ResetAutoRepeat,
    ResetAutoWrap,
    ResetInterlacing,
    ResetMode(u8),
    SelectGraphicRendition(&'a str),
    SetAlternateKeypad,
    SetAutoRepeat,
    SetAutoWrap,
    SetCol132,
    SetCol80,
    SetCursorKeyToCursor,
    SetG0AltAndSpecialGraph,
    SetG0AlternateChar,
    SetG0SpecialChars,
    SetG1AltAndSpecialGraph,
    SetG1AlternateChar,
    SetG1SpecialChars,
    SetInterlacing,
    SetJumpScrolling,
    SetLineFeedMode,
    SetMode(u8),
    SetNewLineMode,
    SetNormalVideo,
    SetNumericKeypad,
    SetOriginAbsolute,
    SetOriginRelative,
    SetReverseVideo,
    SetSingleShift2,
    SetSingleShift3,
    SetSmoothScroll,
    SetTopAndBottom(u32, u32),
    SetUKG0,
    SetUKG1,
    SetUSG0,
    SetUSG1,
    SetVT52,
    ShowCursor,
}

An ANSI Escape Sequence.

You can find some specification on

• wiki
• VT51

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CursorBackward(u32)

A move cursor backward.

Moves the cursor n (default 1) cells backwards.

CursorDown(u32)

A cursor down.

Moves the cursor n (default 1) cells down.

CursorForward(u32)

A move cursor forward.

Moves the cursor n (default 1) cells forward.

CursorPos(u32, u32)

A cursor position.

The values are 1-based, and default to 1 (top left corner) if omitted.

CursorRestore

A restore of current cursor position/state.

CursorSave

A save of current cursor position/state.

CursorToApp

Set cursor key to application

CursorUp(u32)

A cursor up.

Moves the cursor n (default 1) cells up.

EraseDisplay

Erase in Display.

EraseLine

Erase in Display.

Escape

A ESC sequence.

HideCursor

Hide the cursor.

ResetAutoRepeat

Reset auto repeat.

ResetAutoWrap

Reset auto wrap.

ResetInterlacing

Reset interlacin.

ResetMode(u8)

Erase in Display.

SelectGraphicRendition(&'a str)

Select Graphic Rendition (SGR), sets display attributes.

SetAlternateKeypad

Set alternate keypad.

SetAutoRepeat

Set auto repeat.

SetAutoWrap

Set auto wrap.

SetCol132

Set number of columns to 132

SetCol80

Set number of columns to 80

SetCursorKeyToCursor

Set cursor key to cursor.

SetG0AltAndSpecialGraph

Set G0 alt char ROM and spec. graphics.

SetG0AlternateChar

Set G0 alternate character ROM.

SetG0SpecialChars

Set G0 special chars. & line set.

SetG1AltAndSpecialGraph

Set G1 alt char ROM and spec. graphics.

SetG1AlternateChar

Set G1 alternate character ROM.

SetG1SpecialChars

Set G1 special chars. & line set.

SetInterlacing

Set interlacing.

SetJumpScrolling

Set jump scrolling.

SetLineFeedMode

Set line feed mode.

SetMode(u8)

Erase in Display.

SetNewLineMode

Set new line mode.

SetNormalVideo

Set normal video.

SetNumericKeypad

Set numeric keypad.

SetOriginAbsolute

Set origin absolute.

SetOriginRelative

Set origin relative.

SetReverseVideo

Set reverse video.

SetSingleShift2

Set single shift 2.

SetSingleShift3

Set single shift 3.

SetSmoothScroll

Set smooth scroll.

SetTopAndBottom(u32, u32)

Set top and bottom lines of a window.

SetUKG0

Set United Kingdom G0 character set.

SetUKG1

Set United Kingdom G1 character set.

SetUSG0

Set United States G0 character set.

SetUSG1

Set United States G1 character set.

SetVT52

Set VT52.

ShowCursor

Show the cursor.

Implementations

impl EscapeCode<'_>

pub fn parse(text: &str) -> Option<EscapeCode<'_>>

Parse an escape code. returns None if the sequence is not supported or it can’t be parsed.

Trait Implementations

impl<'a> Clone for EscapeCode<'a>

fn clone(&self) -> EscapeCode<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EscapeCode<'a>

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

Formats the value using the given formatter.

impl Display for EscapeCode<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for EscapeCode<'a>

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<'a> Ord for EscapeCode<'a>

fn cmp(&self, other: &EscapeCode<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<EscapeCode<'a>> for EscapeCode<'a>

fn eq(&self, other: &EscapeCode<'a>) -> bool

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

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

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

impl<'a> PartialOrd<EscapeCode<'a>> for EscapeCode<'a>

fn partial_cmp(&self, other: &EscapeCode<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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<'a> Copy for EscapeCode<'a>

impl<'a> Eq for EscapeCode<'a>

impl<'a> StructuralEq for EscapeCode<'a>

impl<'a> StructuralPartialEq for EscapeCode<'a>