routee-compass-core 0.19.3

The core routing algorithms and data structures of the RouteE-Compass energy-aware routing engine
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

use kdam::{Bar, BarBuilder};

/// environment variable used to denote if the progress bar should be used.
/// if COMPASS_PROGRESS=false, the bar is deactivated, otherwise it runs.
const COMPASS_PROGRESS: &str = "COMPASS_PROGRESS";

/// helper function for building a progress bar.
/// a progress bar is created only if:
///   - the `progress` argument is not None
///   - the logging system is set to DEBUG or INFO
///   - the COMPASS_PROGRESS environment variable is not set to "false"
///
/// # Arguments
///
/// * `progress` - progress bar configuration
///
/// # Returns
///
/// Some progress bar if it should be built, else None
pub fn build_progress_bar(progress: BarBuilder) -> Option<Bar> {
    let progress_disabled = std::env::var(COMPASS_PROGRESS)
        .ok()
        .map(|v| v.to_lowercase() == "false")
        .unwrap_or_default();
    let log_info_enabled = log::log_enabled!(log::Level::Info);
    if !progress_disabled && log_info_enabled {
        progress.build().ok()
    } else {
        None
    }
}