Struct alacritty_terminal::term::Term

pub struct Term<T> {
    pub dirty: bool,
    pub visual_bell: VisualBell,
    pub is_focused: bool,
    pub vi_mode_cursor: ViModeCursor,
    pub selection: Option<Selection>,
    // some fields omitted
}

Fields

dirty: bool

Terminal requires redraw.

visual_bell: VisualBell

Visual bell configuration and status.

is_focused: bool

Terminal focus controlling the cursor shape.

vi_mode_cursor: ViModeCursor

Cursor for keyboard selection.

selection: Option<Selection>

Implementations

impl<T> Term<T>

pub fn start_search(&mut self, search: &str)

Enter terminal buffer search mode.

pub fn cancel_search(&mut self)

Cancel active terminal buffer search.

pub fn search_next(
    &self,
    origin: Point<usize>,
    direction: Direction,
    side: Side,
    max_lines: Option<usize>
) -> Option<RangeInclusive<Point<usize>>>

Get next search match in the specified direction.

pub fn regex_search_left(
    &self,
    start: Point<usize>,
    end: Point<usize>
) -> Option<RangeInclusive<Point<usize>>>

Find the next regex match to the left of the origin point.

The origin is always included in the regex.

pub fn regex_search_right(
    &self,
    start: Point<usize>,
    end: Point<usize>
) -> Option<RangeInclusive<Point<usize>>>

Find the next regex match to the right of the origin point.

The origin is always included in the regex.

pub fn bracket_search(&self, point: Point<usize>) -> Option<Point<usize>>

Find next matching bracket.

pub fn semantic_search_left(&self, point: Point<usize>) -> Point<usize>

Find left end of semantic block.

pub fn semantic_search_right(&self, point: Point<usize>) -> Point<usize>

Find right end of semantic block.

pub fn line_search_left(&self, point: Point<usize>) -> Point<usize>

Find the beginning of the current line across linewraps.

pub fn line_search_right(&self, point: Point<usize>) -> Point<usize>

Find the end of the current line across linewraps.

impl<T> Term<T>

pub fn scroll_display(&mut self, scroll: Scroll) where
    T: EventListener, 

pub fn new<C>(config: &Config<C>, size: &SizeInfo, event_proxy: T) -> Term<T>

pub fn update_config<C>(&mut self, config: &Config<C>) where
    T: EventListener, 

pub fn selection_to_string(&self) -> Option<String>

Convert the active selection to a String.

pub fn bounds_to_string(&self, start: Point<usize>, end: Point<usize>) -> String

Convert range between two points to a String.

pub fn visible_to_buffer(&self, point: Point) -> Point<usize>

pub fn grid(&self) -> &Grid<Cell>

Access to the raw grid data structure.

This is a bit of a hack; when the window is closed, the event processor serializes the grid state to a file.

pub fn renderable_cells<'b, C>(
    &'b self,
    config: &'b Config<C>
) -> RenderableCellsIter<C>ⓘ

Important traits for RenderableCellsIter<'a, C>

impl<'a, C> Iterator for RenderableCellsIter<'a, C> type Item = RenderableCell;

Iterate over the renderable cells in the terminal.

A renderable cell is any cell which has content other than the default background color. Cells with an alternate background color are considered renderable as are cells with any text content.

pub fn resize(&mut self, size: &SizeInfo)

Resize terminal to new dimensions.

pub fn mode(&self) -> &TermMode

Active terminal modes.

pub fn swap_alt(&mut self)

Swap primary and alternate screen buffer.

pub fn background_color(&self) -> Rgb

pub fn exit(&mut self) where
    T: EventListener, 

pub fn toggle_vi_mode(&mut self)

Toggle the vi mode.

pub fn vi_motion(&mut self, motion: ViMotion) where
    T: EventListener, 

Move vi mode cursor.

pub fn vi_goto_point(&mut self, point: Point<usize>) where
    T: EventListener, 

Move vi cursor to absolute point in grid.

pub fn scroll_to_point(&mut self, point: Point<usize>) where
    T: EventListener, 

Scroll display to point if it is outside of viewport.

pub fn expand_wide(
    &self,
    point: Point<usize>,
    direction: Direction
) -> Point<usize>

Jump to the end of a wide cell.

pub fn semantic_escape_chars(&self) -> &str

Trait Implementations

impl<T> Dimensions for Term<T>

fn cols(&self) -> Column

Width of the terminal in columns.

fn screen_lines(&self) -> Line

Height of the viewport in lines.

fn total_lines(&self) -> usize

Total number of lines in the buffer, this includes scrollback and visible lines.

fn history_size(&self) -> usize

Number of invisible lines part of the scrollback history.

impl<T: EventListener> Handler for Term<T>

fn input(&mut self, c: char)

A character to be displayed.

fn decaln(&mut self)

Run the decaln routine.

fn goto(&mut self, line: Line, col: Column)

Set cursor to position.

fn goto_line(&mut self, line: Line)

Set cursor to specific row.

fn goto_col(&mut self, col: Column)

Set cursor to specific column.

fn insert_blank(&mut self, count: Column)

Insert blank characters in current line starting from cursor.

fn move_up(&mut self, lines: Line)

Move cursor up rows.

fn move_down(&mut self, lines: Line)

Move cursor down rows.

fn move_forward(&mut self, cols: Column)

Move cursor forward cols.

fn move_backward(&mut self, cols: Column)

Move cursor backward cols.

fn identify_terminal<W: Write>(&mut self, writer: &mut W)

Identify the terminal (should write back to the pty stream).

fn device_status<W: Write>(&mut self, writer: &mut W, arg: usize)

Report device status.

fn move_down_and_cr(&mut self, lines: Line)

Move cursor down rows and set to column 1.

fn move_up_and_cr(&mut self, lines: Line)

Move cursor up rows and set to column 1.

fn put_tab(&mut self, count: i64)

Insert tab at cursor position.

fn backspace(&mut self)

Backspace count characters.

fn carriage_return(&mut self)

Carriage return.

fn linefeed(&mut self)

Linefeed.

fn bell(&mut self)

Set current position as a tabstop.

fn substitute(&mut self)

Substitute char under cursor.

fn newline(&mut self)

Run LF/NL.

LF/NL mode has some interesting history. According to ECMA-48 4th edition, in LINE FEED mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause only movement of the active position in the direction of the line progression.

In NEW LINE mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause movement to the line home position on the following line, the following form, etc. In the case of LF this is referred to as the New Line (NL) option.

Additionally, ECMA-48 4th edition says that this option is deprecated. ECMA-48 5th edition only mentions this option (without explanation) saying that it's been removed.

As an emulator, we need to support it since applications may still rely on it.

fn set_horizontal_tabstop(&mut self)

Set current position as a tabstop.

fn scroll_up(&mut self, lines: Line)

Scroll up rows rows.

fn scroll_down(&mut self, lines: Line)

Scroll down rows rows.

fn insert_blank_lines(&mut self, lines: Line)

Insert count blank lines.

fn delete_lines(&mut self, lines: Line)

Delete count lines.

fn erase_chars(&mut self, count: Column)

Erase count chars in current line following cursor.

fn delete_chars(&mut self, count: Column)

Delete count chars.

fn move_backward_tabs(&mut self, count: i64)

Move backward count tabs.

fn move_forward_tabs(&mut self, count: i64)

Move forward count tabs.

fn save_cursor_position(&mut self)

Save current cursor position.

fn restore_cursor_position(&mut self)

Restore cursor position.

fn clear_line(&mut self, mode: LineClearMode)

Clear current line.

fn set_color(&mut self, index: usize, color: Rgb)

Set the indexed color value.

fn dynamic_color_sequence<W: Write>(
    &mut self,
    writer: &mut W,
    code: u8,
    index: usize,
    terminator: &str
)

Write a foreground/background color escape sequence with the current color.

fn reset_color(&mut self, index: usize)

Reset the indexed color to original value.

fn clipboard_store(&mut self, clipboard: u8, base64: &[u8])

Store data into clipboard.

fn clipboard_load(&mut self, clipboard: u8, terminator: &str)

Load data from clipboard.

fn clear_screen(&mut self, mode: ClearMode)

Clear screen.

fn clear_tabs(&mut self, mode: TabulationClearMode)

Clear tab stops.

fn reset_state(&mut self)

Reset all important fields in the term struct.

fn reverse_index(&mut self)

Reverse Index.

fn terminal_attribute(&mut self, attr: Attr)

Set a terminal attribute.

fn set_mode(&mut self, mode: Mode)

Set mode.

fn unset_mode(&mut self, mode: Mode)

Unset mode.

fn set_scrolling_region(&mut self, top: usize, bottom: Option<usize>)

DECSTBM - Set the terminal scrolling region.

fn set_keypad_application_mode(&mut self)

DECKPAM - Set keypad to applications mode (ESCape instead of digits).

fn unset_keypad_application_mode(&mut self)

DECKPNM - Set keypad to numeric mode (digits instead of ESCape seq).

fn configure_charset(&mut self, index: CharsetIndex, charset: StandardCharset)

Assign a graphic character set to G0, G1, G2 or G3.

fn set_active_charset(&mut self, index: CharsetIndex)

Set one of the graphic character sets, G0 to G3, as the active charset.

fn set_cursor_style(&mut self, style: Option<CursorStyle>)

Set the cursor style.

fn set_title(&mut self, title: Option<String>)

OSC to set window title.

fn push_title(&mut self)

Push a title onto the stack.

fn pop_title(&mut self)

Pop the last title from the stack.