os2 0.1.1

os2 - a library for working with operating system features in Rust
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

#![doc = include_str!("../README.md")]

mod linux;
pub use linux::Linux as LinuxOs;

use std::str::FromStr;
use strum::{AsRefStr, Display, EnumIs};

#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "rune", derive(rune::Any))]
#[derive(Debug, Hash, Eq, Clone, Copy, Default, Display, EnumIs, AsRefStr, PartialEq)]
#[strum(serialize_all = "snake_case")]
pub enum Os {
    #[default]
    #[strum(serialize = "unknown")]
    Unknown,
    #[strum(transparent)]
    Linux(LinuxOs),
    #[strum(serialize = "windows")]
    Windows,
    #[strum(serialize = "macos")]
    MacOs,
    #[strum(serialize = "unix")]
    Unix,
}

impl Os {
    pub fn linux() -> Self {
        Os::Linux(LinuxOs::default())
    }
    /// Confirms if the current operating system is compatible with another.
    /// # Examples
    /// ```
    /// use os2::Os;
    /// let os = Os::Linux(os2::LinuxOs::Ubuntu);
    /// assert!(os.compatible(&Os::Linux(os2::LinuxOs::Ubuntu)));
    /// assert!(!os.compatible(&Os::Linux(os2::LinuxOs::Arch)));
    /// assert!(os.compatible(&Os::Linux(os2::LinuxOs::Unknown)));
    /// assert!(os.compatible(&Os::Unix));
    /// ```
    pub fn compatible(&self, other: &Os) -> bool {
        match other {
            Os::Unknown => true,
            Os::Linux(LinuxOs::Unknown) => matches!(self, Os::Linux(_)),
            Os::Linux(linux) => match self {
                Os::Linux(other_linux) => linux == other_linux,
                _ => false,
            },
            Os::Windows => self == &Os::Windows,
            Os::MacOs => self == &Os::MacOs,
            Os::Unix => matches!(self, Os::Linux(_) | Os::Unix | Os::MacOs),
        }
    }
    /// Returns the next compatible operating system.
    /// # Examples
    /// ```
    /// use os2::Os;
    /// let os = Os::MacOs;
    /// assert_eq!(os.next_compatible(), Some(Os::Unix));
    /// let os = Os::Linux(os2::LinuxOs::Ubuntu);
    /// assert_eq!(os.next_compatible(), Some(Os::Linux(os2::LinuxOs::Unknown)));
    /// let os = Os::Unknown;
    /// assert_eq!(os.next_compatible(), None);
    /// ```
    pub fn next_compatible(&self) -> Option<Os> {
        match self {
            Os::Unknown => None,
            Os::Linux(linux) if linux.is_unknown() => Some(Os::Unix),
            Os::Linux(_) => Some(Os::linux()),
            Os::Windows => Some(Os::Unknown), //NOTE:Need to be confirmed
            Os::MacOs => Some(Os::Unix),      //NOTE:Need to be confirmed
            Os::Unix => Some(Os::Unknown),    //NOTE:Need to be confirmed
        }
    }
}

impl From<&str> for Os {
    fn from(s: &str) -> Self {
        if let Ok(os) = LinuxOs::from_str(s) {
            Os::Linux(os)
        } else {
            match s {
                "windows" => Os::Windows,
                "macos" => Os::MacOs,
                "unix" => Os::Unix,
                _ => Os::Unknown,
            }
        }
    }
}

impl From<&String> for Os {
    fn from(s: &String) -> Self {
        Os::from(s.as_str())
    }
}

impl From<String> for Os {
    fn from(s: String) -> Self {
        Os::from(s.as_str())
    }
}
/// Detect the current operating system.
pub fn detect() -> Os {
    if cfg!(target_os = "linux") {
        Os::Linux(LinuxOs::detect())
    } else if cfg!(target_os = "windows") {
        Os::Windows
    } else if cfg!(target_os = "macos") {
        Os::MacOs
    } else {
        Os::Unknown
    }
}

#[test]
fn test_os_convert() {
    assert_eq!(Os::Unknown.as_ref(), "unknown");
    assert_eq!(Os::Linux(LinuxOs::Unknown).as_ref(), "linux");
    assert_eq!(Os::from("linux"), Os::Linux(LinuxOs::Unknown));
    assert_eq!(Os::from("manjaro"), Os::Linux(LinuxOs::Manjaro));
    assert_eq!(Os::from("unknown"), Os::Unknown);
}