Struct Control 

pub struct Control { /* private fields */ }

A composable terminal control sequence.

A Control holds one or more ANSI escape sequences and can render them as raw ANSI bytes or as a crate::segment::Segment with control codes.

This is the Rust equivalent of Python Rich’s Control class.

Examples

use rusty_rich::control::{Control, control_home, control_clear};

// Named constructors
let home = control_home();

// Build combined controls
let clear_and_home = Control::new(&["\x1b[2J", "\x1b[H"]);

// Cursor positioning
let go_to = Control::cursor_to(10, 5);

Implementations

impl Control

pub fn new(sequences: &[&str]) -> Self

Create a Control from a slice of raw ANSI escape sequences.

pub fn bell() -> Self

Ring the terminal bell.

pub fn home() -> Self

Move cursor to home position.

pub fn clear() -> Self

Clear the entire screen.

pub fn clear_home() -> Self

Clear screen and move cursor to home.

pub fn cursor_up(n: u16) -> Self

Move cursor up by n rows.

pub fn cursor_down(n: u16) -> Self

Move cursor down by n rows.

pub fn cursor_forward(n: u16) -> Self

Move cursor forward by n columns.

pub fn cursor_back(n: u16) -> Self

Move cursor back by n columns.

pub fn cursor_to(row: u16, col: u16) -> Self

Move cursor to an absolute position (1-based row, column).

pub fn cursor_to_row(row: u16) -> Self

Move cursor to a specific row (1-based).

pub fn cursor_to_column(col: u16) -> Self

Move cursor to a specific column (1-based).

pub fn alt_screen(enable: bool) -> Self

Enable or disable the alternate screen buffer.

pub fn show_cursor(show: bool) -> Self

Show or hide the cursor.

pub fn title(title: impl Into<String>) -> Self

Set the terminal window title.

pub fn erase_end_line() -> Self

Erase from cursor to end of line.

pub fn erase_start_line() -> Self

Erase from cursor to beginning of line.

pub fn erase_line() -> Self

Erase the entire current line.

pub fn erase_end_screen() -> Self

Erase from cursor to end of screen.

pub fn erase_start_screen() -> Self

Erase from cursor to beginning of screen.

pub fn insert_lines(n: u16) -> Self

Insert n blank lines at the cursor position.

pub fn delete_lines(n: u16) -> Self

Delete n lines at the cursor position.

pub fn carriage_return() -> Self

Carriage return.

pub fn newline() -> Self

Newline.

pub fn to_ansi(&self) -> String

Convert this Control to a single ANSI escape sequence string.

pub fn sequences(&self) -> &[String]

Return the individual ANSI sequences.

pub fn len(&self) -> usize

Return the number of control sequences in this command.

pub fn is_empty(&self) -> bool

Return true if this control has no sequences.

Trait Implementations

impl Clone for Control

fn clone(&self) -> Control

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Control

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

Formats the value using the given formatter.