jabba-lib 0.1.8

A utility library, inspired mainly by Python.
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

//! connection to the operating system

use std::env;

/// Returns the short name of the underlying operating system.
///
/// Posible values are listed here: [https://doc.rust-lang.org/std/env/consts/constant.OS.html](https://doc.rust-lang.org/std/env/consts/constant.OS.html)
///
/// # Examples
///
/// ```
/// let name = jabba_lib::jos::get_operating_system_name();
/// ```
pub fn get_operating_system_name() -> &'static str {
    env::consts::OS
}

/// Returns `true` if the operating system is Linux.
///
/// # Examples
///
/// ```
/// let are_we_on_linux = jabba_lib::jos::is_linux();
/// ```
pub fn is_linux() -> bool {
    get_operating_system_name() == "linux"
}

/// Returns `true` if the operating system is Windows.
///
/// # Examples
///
/// ```
/// let are_we_on_windows = jabba_lib::jos::is_windows();
/// ```
pub fn is_windows() -> bool {
    get_operating_system_name() == "windows"
}

// ==========================================================================

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn get_operating_system_name_test() {
        assert!(get_operating_system_name().len() > 0);
    }

    #[test]
    fn is_linux_test() {
        assert!(is_linux() != is_windows());
    }

    #[test]
    fn is_windows_test() {
        assert!(is_windows() != is_linux());
    }
}