Struct Term

pub struct Term {
    pub terminal: Terminal<CrosstermBackend<Stdout>>,
}

Fields

terminal: Terminal<CrosstermBackend<Stdout>>

Implementations

impl Term

pub fn start() -> Result<Self>

pub fn enter(&mut self) -> Result<()>

pub fn exit(&mut self) -> Result<()>

pub fn suspend(&mut self) -> Result<()>

pub fn resume(&mut self) -> Result<()>

pub fn size() -> WindowSize

Methods from Deref<Target = Terminal<Backend<Stdout>>>

pub fn get_frame(&mut self) -> Frame<'_, B>

Get a Frame object which provides a consistent view into the terminal state for rendering.

pub fn current_buffer_mut(&mut self) -> &mut Buffer

pub fn backend(&self) -> &B

pub fn backend_mut(&mut self) -> &mut B

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

Obtains a difference between the previous and the current buffer and passes it to the current backend for drawing.

pub fn resize(&mut self, size: Rect) -> Result<(), Error>

Updates the Terminal so that internal buffers match the requested size. Requested size will be saved so the size can remain consistent when rendering. This leads to a full clear of the screen.

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

Queries the backend for size and resizes if it doesn’t match the previous size.

pub fn draw<F>(&mut self, f: F) -> Result<CompletedFrame<'_>, Error>

where F: FnOnce(&mut Frame<'_, B>),

Synchronizes terminal size, calls the rendering closure, flushes the current internal state and prepares for the next draw call.

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

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

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

pub fn set_cursor(&mut self, x: u16, y: u16) -> Result<(), Error>

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

Clear the terminal and force a full redraw on the next draw call.

pub fn swap_buffers(&mut self)

Clears the inactive buffer and swaps it with the current buffer

pub fn size(&self) -> Result<Rect, Error>

Queries the real size of the backend.

pub fn insert_before<F>(&mut self, height: u16, draw_fn: F) -> Result<(), Error>

where F: FnOnce(&mut Buffer),

Insert some content before the current inline viewport. This has no effect when the viewport is fullscreen.

This function scrolls down the current viewport by the given height. The newly freed space is then made available to the draw_fn closure through a writable Buffer.

Before:

+-------------------+
|                   |
|      viewport     |
|                   |
+-------------------+

After:

+-------------------+
|      buffer       |
+-------------------+
+-------------------+
|                   |
|      viewport     |
|                   |
+-------------------+

Examples

Insert a single line before the current viewport

terminal.insert_before(1, |buf| {
    Paragraph::new(Line::from(vec![
        Span::raw("This line will be added "),
        Span::styled("before", Style::default().fg(Color::Blue)),
        Span::raw(" the current viewport")
    ])).render(buf.area, buf);
});

Trait Implementations

impl Deref for Term

type Target = Terminal<CrosstermBackend<Stdout>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Term

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for Term

fn drop(&mut self)

Executes the destructor for this type.