Struct ProgressLine 

pub struct ProgressLine { /* private fields */ }

Tracks the last rendered width and constructs carriage-return progress frames.

Input controls are escaped before width accounting. Callers write returned frames verbatim and own terminal detection, input limits, clipping to prevent wrapping, output failures, flushing and when to finish or clear the line. Width sums Unicode scalar columns, like crate::width::fit_line, conservatively counting joined emoji separately rather than as one grapheme. No output or automatic cleanup occurs when this value is dropped.

Implementations

impl ProgressLine

pub const fn new() -> Self

Start with no outstanding progress text.

pub fn update(&mut self, text: &str) -> String

Replace the current text, blanking columns left by a longer previous frame.

pub fn finish(&mut self, text: &str) -> String

Render the final text and newline, then forget the outstanding width.

pub fn clear(&mut self) -> String

Blank outstanding text and return to its starting column. Returns an empty string when no columns need clearing.

Trait Implementations

impl Debug for ProgressLine

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

Formats the value using the given formatter.

impl Default for ProgressLine

fn default() -> Self

Returns the “default value” for a type.