Struct Frame 

pub struct Frame { /* private fields */ }

Logical output from a Component::render call: a vector of Lines plus a Cursor position.

A Frame is a pure data structure with no terminal formatting. The Renderer consumes frames, diffs them against the previous render, and emits only the changed ANSI sequences.

Construction

use tui::{Frame, Line};
use tui::Cursor;

let frame = Frame::new(vec![
    Line::new("Hello, world!"),
    Line::new("Press q to quit"),
]);

// Optionally place a visible cursor
let frame = frame.with_cursor(Cursor::visible(0, 5));

Methods

• lines() — Borrow the rendered lines.
• cursor() — The current cursor state.
• with_cursor(cursor) — Replace the cursor (builder pattern, moves self).
• clamp_cursor() — Clamp the cursor row to the last line index, preventing out-of-bounds positions.
• into_lines() — Consume the frame and return the lines.
• into_parts() — Consume and return (Vec<Line>, Cursor).

See also

• Cursor — Logical cursor with row, col, and visibility.
• Line — A single line of styled terminal output.
• Renderer — Consumes frames and renders them to the terminal.
• Layout — Composes multiple frames vertically.

Implementations

impl Frame

pub fn new(lines: Vec<Line>) -> Self

pub fn lines(&self) -> &[Line]

pub fn cursor(&self) -> Cursor

pub fn with_cursor(self, cursor: Cursor) -> Self

Replace the cursor without cloning lines.

pub fn into_lines(self) -> Vec<Line>

pub fn into_parts(self) -> (Vec<Line>, Cursor)

pub fn clamp_cursor(self) -> Self

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Frame

impl StructuralPartialEq for Frame