Struct tuikit::output::Output

pub struct Output { /* fields omitted */ }

Output is an abstraction over the ANSI codes.

Implementations

impl Output

pub fn new(stdout: Box<dyn WriteAndAsRawFdAndSend>) -> Result<Self>

pub fn write(&mut self, data: &str)

Write text (Terminal escape sequences will be removed/escaped.)

pub fn write_raw(&mut self, data: &[u8])

Write raw texts to the terminal.

pub fn encoding(&self) -> &str

Return the encoding for this output, e.g. 'utf-8'. (This is used mainly to know which characters are supported by the output the data, so that the UI can provide alternatives, when required.)

pub fn set_title(&mut self, title: &str)

Set terminal title.

pub fn clear_title(&mut self)

Clear title again. (or restore previous title.)

pub fn flush(&mut self)

Write to output stream and flush.

pub fn erase_screen(&mut self)

Erases the screen with the background colour and moves the cursor to home.

pub fn enter_alternate_screen(&mut self)

Go to the alternate screen buffer. (For full screen applications).

pub fn quit_alternate_screen(&mut self)

Leave the alternate screen buffer.

pub fn enable_mouse_support(&mut self)

Enable mouse.

pub fn disable_mouse_support(&mut self)

Disable mouse.

pub fn erase_end_of_line(&mut self)

Erases from the current cursor position to the end of the current line.

pub fn erase_down(&mut self)

Erases the screen from the current line down to the bottom of the screen.

pub fn reset_attributes(&mut self)

Reset color and styling attributes.

pub fn set_fg(&mut self, color: Color)

Set current foreground color

pub fn set_bg(&mut self, color: Color)

Set current background color

pub fn set_effect(&mut self, effect: Effect)

Set current effect (underline, bold, etc)

pub fn set_attribute(&mut self, attr: Attr)

Set new color and styling attributes.

pub fn disable_autowrap(&mut self)

Disable auto line wrapping.

pub fn enable_autowrap(&mut self)

Enable auto line wrapping.

pub fn cursor_goto(&mut self, row: usize, column: usize)

Move cursor position.

pub fn cursor_up(&mut self, amount: usize)

Move cursor amount place up.

pub fn cursor_down(&mut self, amount: usize)

Move cursor amount place down.

pub fn cursor_forward(&mut self, amount: usize)

Move cursor amount place forward.

pub fn cursor_backward(&mut self, amount: usize)

Move cursor amount place backward.

pub fn hide_cursor(&mut self)

Hide cursor.

pub fn show_cursor(&mut self)

Show cursor.

pub fn ask_for_cpr(&mut self)

Asks for a cursor position report (CPR). (VT100 only.)

pub fn bell(&mut self)

Sound bell.

pub fn terminal_size(&self) -> Result<(usize, usize)>

get terminal size (width, height)

pub fn enable_bracketed_paste(&mut self)

For vt100/xterm etc.

pub fn disable_bracketed_paste(&mut self)

For vt100/xterm etc.

pub fn execute(&mut self, cmd: Command)

Execute the command