Struct Terminal 

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

A terminal interface managing rendering and buffering.

The terminal orchestrates frame rendering, maintains double buffers, and coordinates with the backend.

Example

use tuxtui_core::terminal::Terminal;
use tuxtui_core::backend::TestBackend;

let backend = TestBackend::new(80, 24);
let mut terminal = Terminal::new(backend).unwrap();
terminal.draw(|frame| {
    // Render widgets
}).unwrap();

Implementations

impl<B: Backend> Terminal<B>

pub fn new(backend: B) -> Result<Self, B::Error>

Create a new terminal with the given backend.

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

Create a new terminal with options.

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

Get the size of the terminal.

pub fn viewport(&self) -> Rect

Get the current viewport.

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

Clear the terminal.

pub fn draw<F>(&mut self, render: F) -> Result<(), B::Error>

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

Draw a frame using the provided closure.

Example

terminal.draw(|frame| {
    let area = frame.area();
    frame.render_widget(widget, area);
})?;

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

Show the cursor.

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

Hide the cursor.

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

Set the cursor position.

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

Get mutable access to the backend.

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

Flush the backend.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.