Struct Live 

pub struct Live { /* private fields */ }

Manages a live-updating region of the terminal.

Implementations

impl Live

pub fn new(renderable: impl Renderable + Send + Sync + 'static) -> Self

Create a new Live display wrapping the given Renderable.

pub fn screen(self) -> Self

Builder: use the alternate screen buffer for full-screen display.

pub fn no_auto_refresh(self) -> Self

Builder: disable automatic periodic refresh.

pub fn refresh_per_second(self, rate: f64) -> Self

Builder: set the refresh rate in Hz (default 4.0).

pub fn transient(self) -> Self

Builder: enable transient mode (live display disappears on stop).

pub fn redirect_stdout(self, redirect: bool) -> Self

Builder: redirect stdout writes into the live display.

pub fn redirect_stderr(self, redirect: bool) -> Self

Builder: redirect stderr writes into the live display.

pub fn add_writer(&mut self, writer: LiveWriter)

Register a writer whose captured content will be rendered during refresh.

pub fn create_writer() -> LiveWriter

Create a LiveWriter that captures output while Live is active.

pub fn start(&mut self) -> Result<()>

Start the live display: enter alternate screen (if configured) and hide cursor.

pub fn stop(&mut self) -> Result<()>

Stop the live display: restore cursor, exit alternate screen, and clean up.

pub fn update( &mut self, renderable: impl Renderable + Send + Sync + 'static, ) -> Result<()>

Replace the displayed content and refresh immediately.

pub fn refresh(&mut self) -> Result<()>

Re-render the current content in place (cursor is moved back to overwrite previous output).

If any RenderHooks are registered, they are applied to the rendered segment lines before the output is written to the terminal.

pub fn is_started(&self) -> bool

Check if the live display is currently running.

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

Get a reference to the current renderable.

Panics

Panics if no renderable has been set (this should not happen with normal usage, as Live::new always creates one).

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

Get the current renderable being displayed.

Panics

Panics if no renderable has been set (this should not happen with normal usage, as Live::new always creates one).

pub fn process_renderables( &self, renderables: &[Box<dyn Renderable>], options: &ConsoleOptions, ) -> Vec<Vec<Segment>>

Process multiple renderables through the Live display pipeline.

Each renderable is rendered with the given options, and the resulting segment lines are collected into a single vector.

pub fn add_render_hook(&mut self, hook: RenderHook)

Add a render hook to the live display.

Hooks are applied in registration order during each refresh, allowing transformation of the rendered segment lines before they are output.

Trait Implementations

impl Debug for Live

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

Formats the value using the given formatter.

impl Drop for Live

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.