Struct TermBuffer

pub struct TermBuffer { /* private fields */ }

Represents a range of lines in a terminal and the cursor position. This is suitable when you don’t want to use an “alternate screen”, but rather retain previous terminal output, such as shell prompts/responses.

New frames are rendered by replacing the lines. All operations work on a relative coordinate system where (0, 0) is the top-left corner of the lines TermBuffer controls.

Further, we never check the actual cursor position, but rather move the cursor relative to its current position. The meaning of (0, 0) is actually the cursor position when TermBuffer first renders.

Implementations

impl TermBuffer

pub fn new() -> Self

pub fn push_line(&mut self, row: impl Into<String>)

Add a row to the desired output

Examples found in repository

examples/term-buffer-triangle.rs (line 47)

pub fn main() {
    let mut state = State(0, Direction::Grow);
    let mut buf = TermBuffer::default();

    loop {
        let count = state.update();
        // let count = MAX;

        for i in 0..count {
            let line = format!("|{}\\", "*".repeat(i));
            buf.push_line(line);
        }
        buf.push_line(format!(" {}", "‾".repeat(count - 1)));

        buf.render_frame();
        buf.flush();
        // x
        std::thread::sleep(std::time::Duration::from_millis(15));
    }
}

pub fn lines(&self) -> u16

pub fn set_next_cursor(&mut self, cursor: (u16, u16))

Positions the cursor where (0, 0) is the first character printed by this program

pub fn forget(&mut self) -> usize

This causes us to skip past the currently displayed buffer area and forget about it, resulting in future renders to happen below it. If this is called, and then the TermBuffer is dropped, the default behavior of clearing the area will be a no-op.

pub fn render_frame(&mut self)

Perform the necessary update to the terminal. This may choose a more optimized update than a full frame.

Examples found in repository

examples/term-buffer-triangle.rs (line 51)

pub fn main() {
    let mut state = State(0, Direction::Grow);
    let mut buf = TermBuffer::default();

    loop {
        let count = state.update();
        // let count = MAX;

        for i in 0..count {
            let line = format!("|{}\\", "*".repeat(i));
            buf.push_line(line);
        }
        buf.push_line(format!(" {}", "‾".repeat(count - 1)));

        buf.render_frame();
        buf.flush();
        // x
        std::thread::sleep(std::time::Duration::from_millis(15));
    }
}

pub fn render_one_line(&mut self, line_index: usize)

pub fn render_full(&mut self)

Renders a complete frame to the terminal

pub fn flush(&mut self)

Examples found in repository

examples/term-buffer-triangle.rs (line 52)

pub fn main() {
    let mut state = State(0, Direction::Grow);
    let mut buf = TermBuffer::default();

    loop {
        let count = state.update();
        // let count = MAX;

        for i in 0..count {
            let line = format!("|{}\\", "*".repeat(i));
            buf.push_line(line);
        }
        buf.push_line(format!(" {}", "‾".repeat(count - 1)));

        buf.render_frame();
        buf.flush();
        // x
        std::thread::sleep(std::time::Duration::from_millis(15));
    }
}

Trait Implementations

impl Default for TermBuffer

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TermBuffer

fn drop(&mut self)

Executes the destructor for this type.