os_info/
lib.rs

1//! `os_info`
2//!
3//! Provides interfaces for getting information about the current operating system, such as type,
4//! version, edition and bitness.
5
6#![deny(
7    missing_debug_implementations,
8    missing_docs,
9    unsafe_code,
10    missing_doc_code_examples
11)]
12
13#[cfg(target_os = "aix")]
14#[path = "aix/mod.rs"]
15mod imp;
16
17#[cfg(target_os = "android")]
18#[path = "android/mod.rs"]
19mod imp;
20
21#[cfg(target_os = "dragonfly")]
22#[path = "dragonfly/mod.rs"]
23mod imp;
24
25#[cfg(target_os = "emscripten")]
26#[path = "emscripten/mod.rs"]
27mod imp;
28
29#[cfg(target_os = "freebsd")]
30#[path = "freebsd/mod.rs"]
31mod imp;
32
33#[cfg(target_os = "illumos")]
34#[path = "illumos/mod.rs"]
35mod imp;
36
37#[cfg(target_os = "linux")]
38#[path = "linux/mod.rs"]
39mod imp;
40
41#[cfg(target_os = "macos")]
42#[path = "macos/mod.rs"]
43mod imp;
44
45#[cfg(target_os = "netbsd")]
46#[path = "netbsd/mod.rs"]
47mod imp;
48
49#[cfg(target_os = "openbsd")]
50#[path = "openbsd/mod.rs"]
51mod imp;
52
53#[cfg(target_os = "redox")]
54#[path = "redox/mod.rs"]
55mod imp;
56
57#[cfg(windows)]
58#[path = "windows/mod.rs"]
59mod imp;
60
61#[cfg(not(any(
62    target_os = "aix",
63    target_os = "android",
64    target_os = "dragonfly",
65    target_os = "emscripten",
66    target_os = "freebsd",
67    target_os = "illumos",
68    target_os = "linux",
69    target_os = "macos",
70    target_os = "netbsd",
71    target_os = "openbsd",
72    target_os = "redox",
73    target_os = "windows"
74)))]
75#[path = "unknown/mod.rs"]
76mod imp;
77
78#[cfg(any(
79    target_os = "linux",
80    target_os = "macos",
81    target_os = "netbsd",
82    target_os = "openbsd"
83))]
84mod architecture;
85mod bitness;
86mod info;
87#[cfg(not(windows))]
88mod matcher;
89mod os_type;
90#[cfg(any(
91    target_os = "aix",
92    target_os = "dragonfly",
93    target_os = "freebsd",
94    target_os = "illumos",
95    target_os = "netbsd",
96    target_os = "openbsd"
97))]
98mod uname;
99mod version;
100
101pub use crate::{bitness::Bitness, info::Info, os_type::Type, version::Version};
102
103/// Returns information about the current operating system (type, version, edition, etc.).
104///
105/// # Examples
106///
107/// ```
108/// use os_info;
109///
110/// let info = os_info::get();
111///
112/// // Print full information:
113/// println!("OS information: {info}");
114///
115/// // Print information separately:
116/// println!("Type: {}", info.os_type());
117/// println!("Version: {}", info.version());
118/// println!("Edition: {:?}", info.edition());
119/// println!("Codename: {:?}", info.codename());
120/// println!("Bitness: {}", info.bitness());
121/// println!("Architecture: {:?}", info.architecture());
122/// ```
123pub fn get() -> Info {
124    imp::current_platform()
125}