Struct TtyBackend 

pub struct TtyBackend { /* private fields */ }

Native Unix terminal backend.

Combines TtyClock, TtyEventSource, and TtyPresenter into a single Backend implementation that the ftui runtime can drive.

When created with TtyBackend::open, the backend enters raw mode and manages the terminal lifecycle via RAII. On drop (including panics), all features are disabled, the cursor is shown, the alt screen is exited, and raw mode is restored — in that order.

When created with TtyBackend::new (headless), no terminal I/O occurs.

Implementations

impl TtyBackend

pub fn new(width: u16, height: u16) -> Self

Create a headless backend (no terminal I/O). Useful for testing.

pub fn with_capabilities( width: u16, height: u16, capabilities: TerminalCapabilities, ) -> Self

Create a headless backend with explicit capabilities.

pub fn open(width: u16, height: u16, options: TtySessionOptions) -> Result<Self>

Open a live terminal session: enter raw mode, enable requested features.

The terminal is fully restored on drop (even during panics, unless panic = "abort").

pub fn is_live(&self) -> bool

Whether this backend has an active terminal session (raw mode).

Trait Implementations

impl Backend for TtyBackend

type Error = Error

Platform-specific error type shared across sub-traits.

type Clock = TtyClock

Clock implementation.

type Events = TtyEventSource

Event source implementation.

type Presenter = TtyPresenter

Presenter implementation.

fn clock(&self) -> &Self::Clock

Access the monotonic clock.

fn events(&mut self) -> &mut Self::Events

Access the event source (mutable for polling/reading).

fn presenter(&mut self) -> &mut Self::Presenter

Access the presenter (mutable for rendering).

impl BackendEventSource for TtyBackend

Allow TtyBackend to be used directly as a BackendEventSource in Program<M, TtyBackend, W>. Delegates to the inner TtyEventSource. This is the primary integration point: the runtime owns a TtyBackend as its event source, which also provides RAII terminal cleanup on drop.

type Error = Error

Platform-specific error type.

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

Query current terminal dimensions (columns, rows).

fn set_features(&mut self, features: BackendFeatures) -> Result<(), Error>

Enable or disable terminal features (mouse, paste, focus, kitty keyboard).

fn poll_event(&mut self, timeout: Duration) -> Result<bool, Error>

Poll for an available event, returning true if one is ready.

fn read_event(&mut self) -> Result<Option<Event>, Error>

Read the next available event, or None if none is ready.

impl Drop for TtyBackend

fn drop(&mut self)

Executes the destructor for this type.