Enum makeup::Ansi

pub enum Ansi {
    CursorPosition(u64, u64),
    CursorStyle(CursorStyle),
    CursorVisibility(CursorVisibility),
    CursorUp(u64),
    CursorDown(u64),
    CursorLeft(u64),
    CursorRight(u64),
    CursorNextLine(u64),
    CursorPreviousLine(u64),
    CursorHorizontalAbsolute(u64),
    SaveCursorPosition,
    RestoreCursorPosition,
    EraseInDisplay(DisplayEraseMode),
    EraseInLine(LineEraseMode),
    ScrollUp(u64),
    ScrollDown(u64),
    TerminalSize(u64, u64),
    TerminalTitle(String),
    TerminalForegroundColour(Colour),
    TerminalBackgroundColour(Colour),
    Sgr(Vec<SgrParameter>),
}

ANSI escape sequences. Can be directly formatted into strings.

Variants

CursorPosition(u64, u64)

Set the (x, y) cursor position.

CursorStyle(CursorStyle)

Set the cursor style.

CursorVisibility(CursorVisibility)

Set the cursor visibility.

CursorUp(u64)

Move the cursor up.

CursorDown(u64)

Move the cursor down.

CursorLeft(u64)

Move the cursor left.

CursorRight(u64)

Move the cursor right.

CursorNextLine(u64)

Move the cursor to the start of line count steps down.

CursorPreviousLine(u64)

Move the cursor to the start of line count steps up.

CursorHorizontalAbsolute(u64)

Move the cursor to the column x.

SaveCursorPosition

Save the current position of the cursor.

RestoreCursorPosition

Restore the position of the cursor.

EraseInDisplay(DisplayEraseMode)

Erase part of the current display.

EraseInLine(LineEraseMode)

Erase part of the current line.

ScrollUp(u64)

Scroll the display up.

ScrollDown(u64)

Scroll the display down.

TerminalSize(u64, u64)

Set the terminal size. This is not supported on Windows.

TerminalTitle(String)

Set the terminal title. This is not supported on Windows.

TerminalForegroundColour(Colour)

Set the terminal foreground colour. This is not supported on Windows.

TerminalBackgroundColour(Colour)

Set the terminal background colour. This is not supported on Windows.

Sgr(Vec<SgrParameter>)

Set attributes on the current terminal. This is not supported on Windows. See: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters

Implementations

impl Ansi

pub fn render(&self, f: &mut impl Write) -> Result<(), Report>

Render this ANSI escape sequence into the given Writeable.

Trait Implementations

impl Clone for Ansi

fn clone(&self) -> Ansi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ansi

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

Formats the value using the given formatter.

impl Display for Ansi

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

Formats the value using the given formatter.

impl Hash for Ansi

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

where __H: Hasher,

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 Ansi

fn cmp(&self, other: &Ansi) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Ansi

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

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

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 PartialOrd for Ansi

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

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

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

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

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

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

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

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

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 Ansi

impl StructuralEq for Ansi

impl StructuralPartialEq for Ansi