Struct Reveal 

pub struct Reveal<'a> { /* private fields */ }

A live terminal reveal session.

Construct it, call render with each new progress value as your task advances, then finish. The terminal is restored on drop even if you forget, and everything degrades to a no-op when stdout is not a TTY (piped, redirected, CI), so the same code is safe everywhere.

Progress may move backwards as well as forwards; the reveal is seekable.

use inkling::{Art, ordering::{Ordering, Geodesic}, render::{Reveal, Style}};

let art = Art::parse(include_str!("../assets/dragon.txt"));
let ranks = Geodesic::default().rank(&art);

let mut reveal = Reveal::new(&art, &ranks, Style::default())?;
for done in 0..=100 {
    reveal.render(done as f32 / 100.0)?;
    // ... do a slice of real work ...
}
reveal.finish()?;

Implementations

impl<'a> Reveal<'a>

pub fn new(art: &'a Art, ranks: &'a RankMap, style: Style) -> Result<Self>

Begin a reveal session. On a TTY this switches to the alternate screen and hides the cursor; otherwise it is inert until finish.

pub fn render(&mut self, progress: f32) -> Result<()>

Render the frame at progress. A no-op when stdout is not a TTY.

pub fn finish(self) -> Result<()>

Restore the terminal and leave the completed art in normal scrollback.

Trait Implementations

impl Drop for Reveal<'_>

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.