Struct TermState 

pub struct TermState {
    pub prompt: String,
    pub mode: u8,
    pub flags: u32,
    pub font: Option<u32>,
    pub size_pt: f32,
    pub pager_text: String,
    pub page_len: u16,
    /* private fields */
}

the state of one console (see the module header); the app keeps it between frames

Fields

prompt: String

the text before the input (SGR allowed)

mode: u8

TM_LINE, TM_BUSY, TM_RAW, TM_SECRET

flags: u32

TF_* added to the flags of ui.terminal

font: Option<u32>

a font id for this console (None: ui.mono_font)

size_pt: f32

the text size in points (default 10)

pager_text: String

the pager’s line (default “ –More– “)

page_len: u16

lines of output per page of the pager (0, the default: the screen minus one line)

Implementations

impl TermState

pub fn new(scrollback: usize) -> TermState

a console keeping scrollback lines (at least 100)

pub fn write(&mut self, s: &[u8])

output: UTF-8 with the ANSI subset of the module header (paged while the pager is on)

pub fn write_str(&mut self, s: &str)

write(s.as_bytes())

pub fn clear(&mut self)

drop the scrollback and the current line (the history stays)

pub fn set_prompt(&mut self, s: &str)

the prompt before the input (SGR allowed)

pub fn set_mode(&mut self, mode: u8)

TM_LINE, TM_BUSY, TM_RAW or TM_SECRET

pub fn input_set(&mut self, s: &str, caret: usize)

replace the input line; caret: a byte index (clamped to a character start)

pub fn input(&self) -> &str

the input line as typed so far

pub fn history(&self) -> &[String]

the lines submitted so far (oldest first)

pub fn complete_reply<S: AsRef<str>>(&mut self, line: &str, list: &[S])

the answer to TermEv::Complete: the new input line (caret at its end); a non-empty list is shown in columns below the line as typed

pub fn pager(&mut self, on: bool)

on: the following output pages (see the module header); off: the app wrote all of it

pub fn pager_waiting(&self) -> bool

the pager holds output and waits for a key

pub fn grid(&self) -> (u16, u16)

the character grid of the last layout (columns, rows; 0 before the first)

pub fn text(&self) -> String

the scrollback and the current line as plain text (lines joined with ‘\n’)

pub fn line_count(&self) -> usize

lines kept in the scrollback