lux-lib 0.36.2

Library for the lux package manager for Lua
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use std::{borrow::Cow, sync::Arc, time::Duration};

use crate::config::Config;

mod private {
    pub trait HasProgress {}
}

impl private::HasProgress for () {}
impl private::HasProgress for MultiProgress {}
impl private::HasProgress for ProgressBar {}

pub trait HasProgress: private::HasProgress {}
impl<P: private::HasProgress> HasProgress for P {}

#[derive(Clone)]
pub struct Progress<T: HasProgress>(ProgressImpl<T>);

#[derive(Clone)]
enum ProgressImpl<T: HasProgress> {
    NoProgress,
    Progress(T),
}

impl<T> Progress<T>
where
    T: HasProgress,
{
    pub fn new(progress: T, config: &Config) -> Progress<T> {
        Progress(if config.no_progress() {
            ProgressImpl::NoProgress
        } else {
            ProgressImpl::Progress(progress)
        })
    }

    pub fn no_progress() -> Progress<T> {
        Progress(ProgressImpl::NoProgress)
    }

    pub fn map<F, R>(&self, callback: F) -> Progress<R>
    where
        F: FnOnce(&T) -> R,
        R: HasProgress,
    {
        Progress(if let ProgressImpl::Progress(progress) = &self.0 {
            ProgressImpl::Progress(callback(progress))
        } else {
            ProgressImpl::NoProgress
        })
    }
}

// WARNING: Don't implement `Clone` for this.
pub struct MultiProgress(indicatif::MultiProgress);
pub struct ProgressBar(indicatif::ProgressBar);

impl MultiProgress {
    pub fn new(config: &Config) -> Progress<Self> {
        Progress::new(Self(indicatif::MultiProgress::new()), config)
    }

    pub fn new_arc(config: &Config) -> Arc<Progress<MultiProgress>> {
        Arc::new(MultiProgress::new(config))
    }

    pub fn add(&self, bar: ProgressBar) -> ProgressBar {
        ProgressBar(self.0.insert_from_back(0, bar.0))
    }

    pub fn new_bar(&self) -> ProgressBar {
        self.add(ProgressBar::new())
    }

    pub fn suspend<F, R>(&self, callback: F) -> R
    where
        F: FnOnce() -> R,
    {
        self.0.suspend(callback)
    }
}

impl ProgressBar {
    pub fn new() -> Self {
        let bar =
            indicatif::ProgressBar::new_spinner().with_finish(indicatif::ProgressFinish::AndClear);
        bar.enable_steady_tick(Duration::from_millis(100));

        Self(bar)
    }

    pub fn into_raw(self) -> indicatif::ProgressBar {
        self.0
    }

    pub fn set_message<M>(&self, message: M)
    where
        M: Into<Cow<'static, str>>,
    {
        self.0.set_message(message)
    }

    pub fn set_position(&self, position: u64) {
        self.0.set_position(position)
    }

    pub fn position(&self) -> u64 {
        self.0.position()
    }

    pub fn println<M>(&self, message: M)
    where
        M: AsRef<str>,
    {
        self.0.println(message)
    }

    pub fn finish_with_message<M>(&self, message: M)
    where
        M: Into<Cow<'static, str>>,
    {
        self.0.finish_with_message(message)
    }

    pub fn finish_and_clear(&self) {
        self.0.finish_and_clear()
    }
}

impl Default for ProgressBar {
    fn default() -> Self {
        Self::new()
    }
}

impl From<String> for ProgressBar {
    fn from(message: String) -> Self {
        Self(Self::new().0.with_message(message))
    }
}

impl From<u64> for ProgressBar {
    fn from(position: u64) -> Self {
        let new = Self::new();
        new.set_position(position);

        new
    }
}