Skip to main content

Crate ratatui_termion

Crate ratatui_termion 

Source
Expand description

This module provides the TermionBackend implementation for the Backend trait. It uses the Termion crate to interact with the terminal.

Most application authors should start with the main ratatui crate and only depend on ratatui-termion directly when they specifically want the Termion backend. This crate is the backend layer, not the primary docs.rs entry point for building applications.

§Crate Organization

ratatui-termion is part of the Ratatui workspace that was modularized in version 0.30.0. This crate provides the Termion backend implementation for Ratatui.

When to use ratatui-termion:

  • You want to depend on the Termion backend crate directly
  • You prefer Termion’s Unix-focused approach

When to use the main ratatui crate:

  • Building applications
  • You want backend selection to stay behind Ratatui’s re-exports

For detailed information about the workspace organization, see ARCHITECTURE.md.

§Features

  • serde — Enables serde for termion dependency
  • scrolling-regions — Use terminal scrolling regions to make Terminal::insert_before less prone to flickering.
  • unstable — Enables all unstable features.
  • unstable-backend-writer — Enables getting access to backends’ writer.

Re-exports§

pub use termion;

Structs§

ResetRegion
Reset scrolling region.
SetRegion
Set scrolling region.
TermionBackend
A Backend implementation that uses Termion to render to the terminal.

Traits§

FromTermion
A trait for converting a Termion type to a Ratatui type.
IntoTermion
A trait for converting a Ratatui type to a Termion type.