Struct Terminal 

pub struct Terminal { /* private fields */ }

Terminal state manager using crossterm for actual terminal control.

This is the primary terminal implementation that provides full terminal control capabilities through the crossterm library. It maintains state to ensure operations are idempotent and efficient.

State Tracking

The terminal tracks various state flags to avoid unnecessary operations:

• Raw mode status
• Alternate screen status
• Mouse capture status
• Focus reporting status
• Cursor visibility

Performance

• Uses a pre-allocated render buffer to minimize allocations
• Tracks state to avoid redundant terminal operations
• Efficiently handles newline conversion for cross-platform compatibility

Example

use bubbletea_rs::terminal::{Terminal, TerminalInterface};
use bubbletea_rs::Error;

let mut terminal = Terminal::new(None)?;

// Set up terminal for TUI mode
terminal.enter_raw_mode().await?;
terminal.enter_alt_screen().await?;
terminal.hide_cursor().await?;

// Render some content
terminal.render("Hello, TUI world!").await?;

// Clean up (or rely on Drop)
terminal.show_cursor().await?;
terminal.exit_alt_screen().await?;
terminal.exit_raw_mode().await?;

Implementations

impl Terminal

pub fn new( output_writer: Option<Arc<Mutex<dyn AsyncWrite + Send + Unpin>>>, ) -> Result<Self, Error>

Create a new Terminal instance.

If an output_writer is provided, rendering is performed by writing to that asynchronous writer instead of directly to stdout.

Trait Implementations

impl Drop for Terminal

fn drop(&mut self)

Executes the destructor for this type.

impl TerminalInterface for Terminal

fn new( output_writer: Option<Arc<Mutex<dyn AsyncWrite + Send + Unpin>>>, ) -> Result<Self, Error>

where Self: Sized,

Construct a new terminal implementation.

fn enter_raw_mode<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable raw mode (disables canonical input processing).

fn exit_raw_mode<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disable raw mode and restore canonical input processing.

fn enter_alt_screen<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enter the alternate screen buffer.

fn exit_alt_screen<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Leave the alternate screen buffer.

fn enable_mouse<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable basic mouse capture.

fn enable_mouse_cell_motion<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable cell-motion mouse reporting.

fn enable_mouse_all_motion<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable high-resolution mouse reporting.

fn disable_mouse<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disable all mouse capture modes.

fn enable_focus_reporting<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable terminal focus change reporting.

fn disable_focus_reporting<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disable terminal focus change reporting.

fn enable_bracketed_paste<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Enable bracketed paste mode.

fn disable_bracketed_paste<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disable bracketed paste mode.

fn show_cursor<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Show the cursor if hidden.

fn hide_cursor<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Hide the cursor if visible.

fn clear<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear the visible screen contents.

fn render<'life0, 'life1, 'async_trait>( &'life0 mut self, content: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Render the provided content to the terminal.

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

Get the current terminal size as (columns, rows).