Trait crossterm::Command

pub trait Command {
    pub fn write_ansi(&self, f: &mut impl Write) -> Result;
}

An interface for a command that performs an action on the terminal.

Crossterm provides a set of commands, and there is no immediate reason to implement a command yourself. In order to understand how to use and execute commands, it is recommended that you take a look at Command Api chapter.

Required methods

pub fn write_ansi(&self, f: &mut impl Write) -> Result

Write an ANSI representation of this commmand to the given writer. An ANSI code can manipulate the terminal by writing it to the terminal buffer. However, only Windows 10 and UNIX systems support this.

This method does not need to be accessed manually, as it is used by the crossterm's Command Api

Loading content...

Implementations on Foreign Types

impl<T: Command + ?Sized> Command for &T

pub fn write_ansi(&self, f: &mut impl Write) -> Result

Loading content...

Implementors

impl Command for DisableBlinking

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for EnableBlinking

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for Hide

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveDown

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveLeft

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveRight

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveTo

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveToColumn

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveToNextLine

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveToPreviousLine

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for MoveUp

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for RestorePosition

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SavePosition

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for Show

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for DisableMouseCapture

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for EnableMouseCapture

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for ResetColor

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetAttribute

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetAttributes

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetBackgroundColor

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetColors

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetForegroundColor

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for Clear

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for DisableLineWrap

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for EnableLineWrap

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for EnterAlternateScreen

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for LeaveAlternateScreen

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for ScrollDown

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for ScrollUp

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl Command for SetSize

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl<'a> Command for SetTitle<'a>

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl<D: Display> Command for PrintStyledContent<D>

pub fn write_ansi(&self, f: &mut impl Write) -> Result

impl<T: Display> Command for Print<T>

pub fn write_ansi(&self, f: &mut impl Write) -> Result

Loading content...