Struct AutoLive 

pub struct AutoLive<W: Write + Send + 'static> { /* private fields */ }

A handle to an auto-refreshing Live running on a background thread. Dropping the handle (or calling stop) finalizes the display.

Implementations

impl<W: Write + Send + 'static> AutoLive<W>

pub fn update(&self, renderable: Box<dyn Renderable + Send>)

Swap in a new renderable; the thread redraws it promptly.

pub fn refresh(&self)

Ask the thread to redraw the current renderable now.

pub fn print(&self, renderable: Box<dyn Renderable + Send>)

Print renderable above the display (Live::print), on the thread.

pub fn print_str(&self, content: impl Into<String>)

Print a string as console markup above the display (Live::print_str), on the thread.

pub fn log( &self, objects: &[LogObject<'_>], options: &LogOptions<'_>, ) -> Result<()>

Log above the display (Live::log), on the thread.

pub fn handle(&self) -> LiveHandle<W>

A cloneable handle to the thread, for proxies and prints from other threads.

pub fn stdout(&self) -> FileProxy<LiveHandle<W>, Stdout>

A writer standing in for stdout while the display runs (upstream’s sys.stdout FileProxy); see Live::stdout.

pub fn stderr(&self) -> FileProxy<LiveHandle<W>, Stderr>

stdout for stderr.

pub fn file_proxy<F: Write>( &self, stream: ProxyStream, file: F, ) -> FileProxy<LiveHandle<W>, F>

A proxy for stream over any file, which receives the writes when the display is not redirecting.

pub fn refresh_wait(&self)

Redraw now and wait until the frame is written, as upstream’s Live.refresh() renders in the caller’s thread. A renderable that reads shared state then shows the state as of this call.

pub fn stop(self) -> W

Commit the final frame, join the thread, and return the output sink.

If a render panicked on the refresh thread, the cursor has already been shown again and the failure is swallowed (the panic hook reported it when it happened); use try_stop to observe it.

pub fn try_stop(self) -> Result<W, LivePanic<W>>

stop, reporting a render that panicked on the refresh thread as an error that still carries the output sink.

Trait Implementations

impl<W: Write + Send + 'static> Drop for AutoLive<W>

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.