Struct AkarProgress 

pub struct AkarProgress { /* private fields */ }

A thin wrapper around indicatif::ProgressBar for Akar operations.

Provides factory methods for common progress styles (spinner, count-based, bytes-transferred) used during bulk ingest, export, and long-running queries.

Example

use akar_common::progress_bar::AkarProgress;

let pb = AkarProgress::new("Loading data…", Some(1000));
for i in 0..1000 {
    pb.inc();
    std::thread::sleep(std::time::Duration::from_millis(1));
}
pb.finish("Done.");

Implementations

impl AkarProgress

pub fn new(msg: &str, total: Option<u64>) -> Self

Create a new progress bar with an optional total count.

When total is None, a spinner is used (indeterminate progress). When total is Some(n), a count-based bar is shown.

pub fn inc(&self)

Advance the progress bar by one step.

pub fn inc_by(&self, delta: u64)

Advance by delta steps.

pub fn set_pos(&self, pos: u64)

Set the current position.

pub fn set_message(&self, msg: &str)

Update the message displayed alongside the bar.

pub fn finish(&self, msg: &str)

Mark as finished with a final message.

pub fn abort(&self)

Abort and clear the progress display.

pub fn cancel(&self)

Mark as cancelled. Callers should check Self::is_cancelled in their work loop to abort early.

pub fn is_cancelled(&self) -> bool

Whether a cancellation has been requested.

pub fn cancelled_flag(&self) -> Arc<AtomicBool>

Get a reference to the cancellation flag for sharing across threads.

Trait Implementations

impl Drop for AkarProgress

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.