Crate osc94

osc94

Library for handling progress bar sequences (OSC 9;4).

💡 Example

use osc94::Progress;
use std::io::Result;

fn main() -> Result<()> {
    let mut progress = Progress::default();
    progress.start();

    for i in 0..=100 {
        work();
        progress.increment(1).flush()?;
    }

    Ok(())
}

See more examples in the examples directory.

📖 Usage

Usually, you’ll only need the Progress struct, which provides a high-level interface and handles clean up job for you when dropped. If you need finer control, you can use the OSC94 struct and ProgressState enum. See the documentation of respective API for more details.

📥 Binary

The provided binary allows you to play with progress bar sequences:

$ osc94
Sets the progress state and value of the progress bar for 1 second.

Usage: osc94 <state> <progress>

States:
  0/hidden
  1/normal
  2/error
  3/indeterminate
  4/warning

Progress: 0-100

It can be installed via the following methods:

Using binstall

cargo binstall osc94

Downloading from Releases

Navigate to the Releases page and download respective binary for your platform. Make sure to give it execute permissions.

Compiling from Source

cargo install osc94

🎉 Credits

• Microsoft Docs on progress bar sequences (GitHub)

Re-exports

pub use raw::OSC94;

Modules

raw

This module is for handling raw progress bar sequence (OSC 9;4).

Structs

Progress

A progress instance.

Enums

ProgressState

Possible states of a progress bar.