Struct ratatui::terminal::Terminal

pub struct Terminal<B>where
    B: Backend,{ /* private fields */ }

Interface to the terminal backed by Termion

Implementations

impl<B> Terminal<B>where B: Backend,

pub fn new(backend: B) -> Result<Terminal<B>>

Wrapper around Terminal initialization. Each buffer is initialized with a blank string and default colors for the foreground and the background

pub fn with_options(backend: B, options: TerminalOptions) -> Result<Terminal<B>>

UNSTABLE

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<()>

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

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

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<()>

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<'_>>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<()>

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

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

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

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

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

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

Queries the real size of the backend.

Trait Implementations

impl<B> Debug for Terminal<B>where B: Backend + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B> Drop for Terminal<B>where B: Backend,

fn drop(&mut self)

Executes the destructor for this type.