oma-console 0.31.0

Console and terminal emulator handling library used by oma
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Progress Bar
//! pb is used as an acronym for Progress Bar

use std::{fmt::Write, time::Duration};

use console::style;
use indicatif::{HumanBytes, ProgressState, ProgressStyle};

const SPINNER_ANIME: &[&str] = &[
    "( ●    )",
    "(  ●   )",
    "(   ●  )",
    "(    ● )",
    "(     ●)",
    "(    ● )",
    "(   ●  )",
    "(  ●   )",
    "( ●    )",
    "(●     )",
];
const GLOBAL_BAR_SMALL_TEMPLATE: &str = " {progress_msg:<59}";
const GLOBAL_BAR_TEMPLATE: &str =
    " {progress_msg:<59} {eta_precise:<11.blue.bold} [{wide_bar:.cyan/blue}] {percent:>4}";
const NORMAL_BAR_SMALL_TEMPLATE: &str = " {msg} {percent:>3}";
const NORMAL_BAR_TEMPLATE: &str =
    " {msg:<59} {total_bytes:<11} [{wide_bar:.white/black}] {percent:>4}";
const SPINNER_TEMPLATE: &str = " {msg:<59} {spinner}";

/// Progress Bar Style
/// Returns a 'ProgressStyle' object that defines the style of the progress bar.
///
/// # Arguments
///
/// * `writer` - A reference to a `Writer` object.
pub fn progress_bar_style(term_length: u16) -> ProgressStyle {
    let template = if term_length < 100 {
        NORMAL_BAR_SMALL_TEMPLATE
    } else {
        NORMAL_BAR_TEMPLATE
    };

    ProgressStyle::default_bar()
        .template(template)
        .unwrap()
        .progress_chars("=>-")
        .with_key("percent", |state: &ProgressState, w: &mut dyn Write| {
            write!(w, "{:.*}%", 0, state.fraction() * 100f32).unwrap()
        })
}
/// Global Progress Bar Style
/// Returns a 'ProgressStyle' object that defines the style of the progress bar.
///
/// # Arguments
///
/// * `writer` - A reference to a `Writer` object.
pub fn global_progress_bar_style(term_length: u16) -> ProgressStyle {
    let template = if term_length < 100 {
        GLOBAL_BAR_SMALL_TEMPLATE
    } else {
        GLOBAL_BAR_TEMPLATE
    };

    ProgressStyle::default_bar()
        .template(template)
        .unwrap()
        .progress_chars("=>-")
        .with_key("percent", |state: &ProgressState, w: &mut dyn Write| {
            write!(w, "{:.*}%", 0, state.fraction() * 100f32).unwrap()
        })
        .with_key("progress_msg", oma_global_bar_template)
}

fn oma_global_bar_template(state: &ProgressState, w: &mut dyn Write) {
    write!(w, "{}  ", style("Progress").blue().bold()).unwrap();

    write!(
        w,
        "{}",
        style(format!(
            "{} / {}",
            HumanBytes(state.pos()),
            HumanBytes(state.len().unwrap_or(0))
        ))
        .green()
        .bold()
    )
    .unwrap();

    write!(
        w,
        "{}",
        style(format!(" @ {}/s", HumanBytes(state.per_sec() as u64)))
            .green()
            .bold()
    )
    .unwrap();
}

pub fn spinner_style() -> (ProgressStyle, Duration) {
    let (template, inv) = (SPINNER_ANIME, 80);

    let style = ProgressStyle::with_template(SPINNER_TEMPLATE)
        .unwrap()
        .tick_strings(template);

    (style, Duration::from_millis(inv))
}