Struct DummyTerminal 

pub struct DummyTerminal { /* private fields */ }

A no-op terminal implementation useful for tests and headless operation.

This terminal implementation provides the TerminalInterface without actually performing any terminal operations. It’s designed for testing, headless environments, or situations where terminal control is not needed.

Use Cases

• Unit testing TUI applications without requiring a real terminal
• Running applications in headless environments
• Debugging and development scenarios
• Performance testing without terminal I/O overhead

Behavior

• All terminal control methods return success without doing anything
• render() writes to the output writer if provided, otherwise does nothing
• size() returns (0, 0) as a placeholder

Example

use bubbletea_rs::terminal::{DummyTerminal, TerminalInterface};
use bubbletea_rs::Error;
use std::sync::Arc;
use tokio::sync::Mutex;

// Create with no output (all operations are no-ops)
let mut dummy = DummyTerminal::new(None)?;

// These all succeed but do nothing
dummy.enter_raw_mode().await?;
dummy.hide_cursor().await?;
dummy.render("This won't be displayed").await?;

Trait Implementations

impl TerminalInterface for DummyTerminal

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

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