Struct TerminaBackend 

pub struct TerminaBackend<T>
where
    T: Terminal,
{ /* private fields */ }

A Backend implementation that renders through a termina::Terminal.

TerminaBackend writes typed Termina escape sequences for drawing, cursor control, clearing, and terminal-size queries.

This backend does not automatically enable raw mode or switch to the alternate screen. Use Termina’s terminal APIs and typed escape sequences to configure those application-level modes before drawing.

Example

use ratatui::Terminal;
use ratatui::backend::TerminaBackend;
use ratatui::termina::{PlatformTerminal, Terminal as _};

let mut output = PlatformTerminal::new()?;
output.enter_raw_mode()?;

let backend = TerminaBackend::new(output);
let mut terminal = Terminal::new(backend)?;

terminal.draw(|frame| {
    // -- snip --
})?;

Implementations

impl<T> TerminaBackend<T>

where T: Terminal,

pub const fn new(terminal: T) -> Self

Creates a backend that writes to the given Termina terminal.

pub const fn terminal(&self) -> &T

Available on crate feature unstable-backend-writer only.

Returns the wrapped terminal.

Stability

This API is marked as unstable and is only available when the unstable-backend-writer crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time. The tracking issue is: https://github.com/ratatui/ratatui/pull/991.

pub const fn terminal_mut(&mut self) -> &mut T

Available on crate feature unstable-backend-writer only.

Returns the wrapped terminal as a mutable reference.

Direct writes can desynchronize Ratatui’s diffing buffers from the visible terminal. Clear the terminal or force a full redraw before relying on Ratatui’s next diff.

Stability

This API is marked as unstable and is only available when the unstable-backend-writer crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time. The tracking issue is: https://github.com/ratatui/ratatui/pull/991.

Trait Implementations

impl<T> Backend for TerminaBackend<T>

where T: Terminal,

type Error = Error

Error type associated with this Backend.

fn draw<'a, I>(&mut self, content: I) -> Result<()>

where I: Iterator<Item = (u16, u16, &'a Cell)>,

Draw the given content to the terminal screen.

fn hide_cursor(&mut self) -> Result<()>

Hide the cursor on the terminal screen.

fn show_cursor(&mut self) -> Result<()>

Show the cursor on the terminal screen.

fn get_cursor_position(&mut self) -> Result<Position>

Get the current cursor position on the terminal screen.

fn set_cursor_position<P: Into<Position>>(&mut self, position: P) -> Result<()>

Set the cursor position on the terminal screen to the given x and y coordinates.

fn clear(&mut self) -> Result<()>

Clears all character cells in the terminal’s visible display area.

fn clear_region(&mut self, clear_type: ClearType) -> Result<()>

Clears a specific region of the terminal’s visible display area, as defined by ClearType.

fn append_lines(&mut self, n: u16) -> Result<()>

Insert n line breaks to the terminal screen.

fn size(&self) -> Result<Size>

Get the size of the terminal screen in columns/rows as a Size.

fn window_size(&mut self) -> Result<WindowSize>

Get the size of the terminal screen in columns/rows and pixels as a WindowSize.

fn flush(&mut self) -> Result<()>

Flush any backend-buffered output to the terminal screen.

fn scroll_region_up(&mut self, region: Range<u16>, amount: u16) -> Result<()>

Available on crate feature scrolling-regions only.

Scroll a region of the screen upwards, where a region is specified by a (half-open) range of rows.

fn scroll_region_down(&mut self, region: Range<u16>, amount: u16) -> Result<()>

Available on crate feature scrolling-regions only.

Scroll a region of the screen downwards, where a region is specified by a (half-open) range of rows.

fn get_cursor(&mut self) -> Result<(u16, u16), Self::Error>

👎Deprecated:

use get_cursor_position() instead which returns Result<Position>

Get the current cursor position on the terminal screen.

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

👎Deprecated:

use set_cursor_position((x, y)) instead which takes impl Into<Position>

Set the cursor position on the terminal screen to the given x and y coordinates.

impl<T> Debug for TerminaBackend<T>

where T: Terminal + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Write for TerminaBackend<T>

where T: Terminal,

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.