Struct libterm::Terminal

pub struct Terminal {
    pub window: Window,
    pub cursor: Cursor,
    /* private fields */
}

An instance of a graphical terminal emulator.

Fields

window: Window

The terminal’s own window.

cursor: Cursor

The cursor of the terminal.

Implementations

impl Terminal

Private methods of Terminal.

pub fn get_text_dimensions(&self) -> (usize, usize)

Gets the width and height of the text displayable in number of characters.

impl Terminal

Public methods of Terminal.

pub fn new() -> Result<Terminal, &'static str>

Creates a new terminal and adds it to the window manager wm_mutex

pub fn print_to_terminal(&mut self, s: String)

Adds a string to be printed to the terminal to the terminal scrollback buffer. Note that one needs to call refresh_display to get things actually printed.

pub fn refresh_display(&mut self) -> Result<(), &'static str>

Actually refresh the screen. Currently it’s expensive.

pub fn insert_char( &mut self, c: char, offset_from_end: usize ) -> Result<(), &'static str>

Insert a character to the terminal.

Arguments

• c: the new character to insert.
• offset_from_end: the position to insert the character. It represents the distance relative to the end of the whole output in the terminal in number of characters.

Examples

• terminal.insert_char(char, 0) will append char to the end of existing text.
• terminal.insert_char(char, 5) will insert char right before the last 5 characters.

After invoke this function, one must call refresh_display to get the updates actually showed on the screen.

pub fn remove_char( &mut self, offset_from_end: usize ) -> Result<(), &'static str>

Remove a character from the terminal.

Arguments

• offset_from_end: the position of the character to remove. It represents the distance relative to the end of the whole output in the terminal in number of characters. offset_from_end == 0 is invalid here.

Examples

• terminal.remove_char(1) will remove the last character in the screen.

After invoke this function, one must call refresh_display to get the updates actually showed on the screen.

pub fn move_screen_to_begin(&mut self) -> Result<(), &'static str>

Scroll the screen to the very beginning.

pub fn move_screen_to_end(&mut self) -> Result<(), &'static str>

Scroll the screen to the very end.

pub fn move_screen_line_up(&mut self) -> Result<(), &'static str>

Scroll the screen a line up.

pub fn move_screen_line_down(&mut self) -> Result<(), &'static str>

Scroll the screen a line down.

pub fn move_screen_page_up(&mut self) -> Result<(), &'static str>

Scroll the screen a page up.

pub fn move_screen_page_down(&mut self) -> Result<(), &'static str>

Scroll the screen a page down.

pub fn clear(&mut self)

Clear the scrollback buffer and reset the scroll positions.

pub fn get_event(&mut self) -> Option<Event>

Gets an event from the window’s event queue.

Returns None if no events have been sent to this window.

pub fn display_cursor(&mut self) -> Result<(), &'static str>

Display the cursor of the terminal.

pub fn get_cursor_offset_from_end(&self) -> usize

Gets the position of the cursor relative to the end of text in number of characters.

pub fn update_cursor_pos(&mut self, offset_from_end: usize, underlying_char: u8)

Updates the position of a cursor.

Arguments

• offset_from_end: the position of the cursor relative to the end of text in number of characters.
• underlying_char: the ASCII code of the underlying character when the cursor is unseen.

pub fn resize(&mut self, new_position: Rectangle) -> Result<(), &'static str>

Resizes this terminal and its underlying text display and then refreshes the window. This does not automatically redisplay the terminal cursor.