Struct Control 

pub struct Control { /* private fields */ }

A renderable that inserts terminal control codes.

Mirrors rich.control.Control. Construct it via the factory methods (Control::clear, [Control::move], …) or Control::new with an explicit list of codes, which are concatenated in order.

Implementations

impl Control

pub fn new(codes: &[ControlType]) -> Self

Build a control from a sequence of codes, rendered end to end.

pub fn bell() -> Self

Ring the terminal bell.

pub fn home() -> Self

Move the cursor to the home position (top-left).

pub fn clear() -> Self

Clear the screen.

pub fn move_(x: i32, y: i32) -> Self

Move the cursor relative to its current position (x columns, y rows; positive is right/down). Port of Control.move.

pub fn move_to_column(x: u32, y: i32) -> Self

Move to a zero-based column, optionally offset the row by y. Port of Control.move_to_column.

pub fn move_to(x: u32, y: u32) -> Self

Move the cursor to an absolute zero-based (x, y) position.

pub fn show_cursor(show: bool) -> Self

Show or hide the cursor.

pub fn alt_screen(enable: bool) -> Self

Enable or disable the terminal’s alternate screen buffer.

pub fn as_str(&self) -> &str

The raw escape string this control emits.

Trait Implementations

impl Renderable for Control

fn rich_render( &self, _console: &Console, _options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, _console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. The default assumes the renderable fills the available width (e.g. Panel, Table); Text overrides it with its content width so the top-level print path can shrink to fit. Port of __rich_measure__ / Measurement.get.