pigeon-cli 0.4.28

Pigeon: authenticate, sink, and transform personal data from external services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! The shared `indicatif` progress-bar style (ADR-0147 §0).
//!
//! Hoisted out of `email_sync::sink`, where it only ever lived because that
//! is where this codebase's first progress bar happened to be needed
//! (ADR-0013). There is nothing email-specific about it, and at two
//! consumers -- `email_import` and `deduplicate` -- a shared module is the
//! right home rather than a copy in each, the same stated exception
//! ADR-0131 §3 made for `download.rs`. The module is named for what it
//! holds, following ADR-0133 §9's `download.rs` -> `local.rs` rename.

use indicatif::{MultiProgress, ProgressBar, ProgressStyle};

/// Builds a `ProgressBar` with the style shared by every phase of every
/// job, so they read consistently in scrollback: `{prefix} {bar:40}
/// {pos}/{len} {msg}`. The trailing `{msg}` (ADR-0099) renders empty unless
/// a caller calls `set_message` -- additive and safe for every bar that
/// never sets one. Registered on `multi_progress` so concurrent workers
/// (ADR-0014) render as simultaneous lines rather than overwriting each
/// other.
///
/// The prefix is bounded to 24 characters by the `{prefix:24!}` template
/// (ADR-0033), so a long mailbox or bucket name cannot push the bar off the
/// line.
pub(crate) fn new_progress_bar(
    prefix: String,
    len: u64,
    multi_progress: &MultiProgress,
) -> ProgressBar {
    let bar = ProgressBar::new(len);
    if let Ok(style) = ProgressStyle::with_template("{prefix:24!} {bar:40} {pos}/{len} {msg}") {
        bar.set_style(style);
    }
    bar.set_prefix(prefix);
    multi_progress.add(bar)
}