Struct liveterm::TermPrinter

pub struct TermPrinter<W> {
    pub buf: String,
    // some fields omitted
}

Wraps stdout, allowing you to clear stuff you previously wrote.

Fields

buf: String

Write the stuff you want to print/clear into this buffer.

Implementations

impl<W: Write> TermPrinter<W>

pub fn new(wtr: W) -> TermPrinter<W>

pub fn clear(&mut self) -> Result<(), Error>

Clear the lines we wrote previously.

Make sure buf still has the same contents as the last time you called TermPrinter::print().

Note that in some cases this is impossible: for instance, if we print N lines and then the user resizes the terminal to something less than N, those lines will end up in the scrollback buffer - there's nothing we can do about that (without switching to the alternate screen).

pub fn print(&mut self) -> Result<(), Error>

Print the visible tail of buf to wtr.

Stuff that scrolls off the top of the terminal end up in the scrollback buffer, where we can't clear it. Therefore this method will only write as many lines as the terminal currently has room for.

pub fn print_all(mut self: Self) -> Result<(), Error>

Print all of buf to wtr.

After this we can't reliably clear what we've written (since it may have gone off the top of the screen). Hence, this method drops the TermPrinter.