Struct crossterm::Crossterm

pub struct Crossterm;

This type offers a easy way to use functionalities like cursor, terminal, color, input, styling.

To get a cursor instance to perform cursor related actions, you can do the following:

let crossterm = Crossterm::new();
let cursor = crossterm.cursor();

Remark

• depending on the feature flags you've enabled you are able to call methods of this type.
• checkout the crossterm book for more information about feature flags or alternate screen.

Methods

impl Crossterm

pub fn new() -> Crossterm

Create a new instance of Crossterm

pub fn cursor(&self) -> TerminalCursor

Get a TerminalCursor implementation whereon cursor related actions can be performed.

let crossterm = Crossterm::new();
let cursor = crossterm.cursor();

pub fn input(&self) -> TerminalInput

Get a TerminalInput implementation whereon terminal related actions can be performed.

let crossterm = Crossterm::new();
let input = crossterm.input();

pub fn terminal(&self) -> Terminal

Get a Terminal implementation whereon terminal related actions can be performed.

let crossterm = Crossterm::new();
let mut terminal = crossterm.terminal();

pub fn color(&self) -> TerminalColor

Get a TerminalColor implementation whereon color related actions can be performed.

let crossterm = Crossterm::new();
let mut terminal = crossterm.color();

pub fn style<D>(&self, val: D) -> StyledObject<D> where
    D: Display, 

This could be used to style any type implementing Display with colors and attributes.

Example

let crossterm = Crossterm::new();

// get an styled object which could be painted to the terminal.
let styled_object = crossterm.style("Some Blue colored text on black background")
    .with(Color::Blue)
    .on(Color::Black);

// print the styled font * times to the current screen.
for i in 1..10
{
    println!("{}", styled_object);
}

Remark

val: any type implementing Display e.g. string.