Struct LiveRender 

pub struct LiveRender { /* private fields */ }

Wraps a renderable for repeated in-place redraws. Mirrors rich.live_render.LiveRender.

Implementations

impl LiveRender

pub fn new(renderable: Box<dyn Renderable>) -> Self

pub fn style(self, style: Style) -> Self

Apply a style across the whole live render.

pub fn vertical_overflow(self, vertical_overflow: VerticalOverflow) -> Self

What to do with content taller than the screen (upstream vertical_overflow, default VerticalOverflow::Ellipsis).

pub fn set_vertical_overflow(&mut self, vertical_overflow: VerticalOverflow)

Set vertical_overflow in place.

pub fn set_renderable(&mut self, renderable: Box<dyn Renderable>)

Replace the wrapped renderable (the shape carries over until the next render). Port of LiveRender.set_renderable.

pub fn renderable(&self) -> &dyn Renderable

The wrapped renderable. Upstream’s LiveRender.renderable.

pub fn last_render_height(&self) -> usize

The height of the last render, 0 before any. Port of LiveRender.last_render_height.

pub fn position_cursor(&self) -> Control

Control codes to move the cursor to the start of the previous render, erasing each line. Port of LiveRender.position_cursor.

pub fn restore_cursor(&self) -> Control

Control codes to clear the render and restore the cursor to where it was before it. Port of LiveRender.restore_cursor.

Trait Implementations

impl Renderable for LiveRender

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Upstream yields no line break after the last line, so a printed LiveRender leaves the cursor at its end (where position_cursor expects it).

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. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.