Struct Terminal

pub struct Terminal { /* private fields */ }

A terminal.

The Terminal instance is stateless and does not hold any data. You can create as many instances as you want and they will always refer to the same terminal.

Examples

Basic usage:

use crossterm_terminal::{Result, Terminal};

fn main() -> Result<()> {
    let terminal = Terminal::new();
    let (cols, rows) = terminal.size()?;

    terminal.set_size(10, 10)?;
    terminal.scroll_up(5)?;

    terminal.set_size(cols, rows)
}

Implementations

impl Terminal

pub fn new() -> Terminal

Creates a new Terminal.

pub fn clear(&self, clear_type: ClearType) -> Result<()>

Clears the terminal.

See the ClearType enum to learn about all ways how the terminal can be cleared.

pub fn size(&self) -> Result<(u16, u16)>

Returns the terminal size ((columns, rows)).

pub fn scroll_up(&self, row_count: u16) -> Result<()>

Scrolls the terminal row_count rows up.

pub fn scroll_down(&self, row_count: u16) -> Result<()>

Scrolls the terminal row_count rows down.

pub fn set_size(&self, columns: u16, rows: u16) -> Result<()>

Sets the terminal size.

pub fn exit(&self)

Exits the current process.

Platform-specific Behavior

std::process::exit is called internally with platform specific exit codes.

Unix: exit code 0.

Windows: exit code 256.

pub fn write<D: Display>(&self, value: D) -> Result<usize>

Writes any displayable content to the current terminal and flushes the standard output.