rcli-loader 0.1.0

RCLI-loader: The Rust client line interface loader crate, a utility built for versatile monitoring of the progress for running tasks
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

use std::{sync::Arc, usize};

pub struct LoadingElement {
    max: usize,
    progress: usize,
    name: Arc<Box<str>>, // TODO: make sure that Arc is the proper use for single write multiple read
    formatter: Option< fn(usize) -> Box<str> >,
}
impl LoadingElement {
    // New functions
    pub fn new(max: usize, name: Box<str>, formatter: Option< fn(usize) -> Box<str> >) -> LoadingElement {
        LoadingElement { max: (max), progress: (0), name: (Arc::new(name)), formatter: (formatter) }
    }
    // pub fn empty() -> LoadingElement {
    //     LoadingElement { max: (0), progress: (0), name: (Rc::new(Box::from(""))) }
    // }

    // Getters
    pub fn get_progress(&self) -> usize {
        return self.progress;
    }
    pub fn get_progress_decimal(&self) -> f64 {
        return self.progress as f64 / self.max as f64;
    }
    pub fn get_max(&self) -> usize {
        return self.max;
    }
    pub fn get_name(&self) -> Arc<Box<str>> {
        return self.name.clone();
    }
    pub fn format_progress_unit(&self, value: usize) -> Box<str> {
        match self.formatter {
            None => Box::from(value.to_string()),
            Some (format_function) => { format_function(value) },
        }
    }

    // Setters
    pub fn set_max(&mut self, max: usize) {
        self.max = max;
    }
    pub fn update(&mut self, addition: usize) {
        self.progress += addition;
    }
}