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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
// // Sysinfo // // Copyright (c) 2015 Guillaume Gomez // use crate::{NetworkData, Networks, NetworksExt, UserExt}; /// Trait to have a common fallback for the [`Pid`][crate::Pid] type. pub trait AsU32 { /// Allows to convert [`Pid`][crate::Pid] into [`u32`]. fn as_u32(&self) -> u32; } cfg_if::cfg_if! { if #[cfg(any(windows, target_os = "unknown", target_arch = "wasm32"))] { /// Process id. pub type Pid = usize; impl AsU32 for Pid { fn as_u32(&self) -> u32 { *self as u32 } } } else { use libc::pid_t; /// Process id. pub type Pid = pid_t; impl AsU32 for Pid { fn as_u32(&self) -> u32 { *self as u32 } } } } macro_rules! impl_get_set { ($name:ident, $with:ident, $without:ident) => { doc_comment::doc_comment! { concat!("Returns the value of the \"", stringify!($name), "\" refresh kind. ``` use sysinfo::RefreshKind; let r = RefreshKind::new(); assert_eq!(r.", stringify!($name), "(), false); let r = r.with_", stringify!($name), "(); assert_eq!(r.", stringify!($name), "(), true); let r = r.without_", stringify!($name), "(); assert_eq!(r.", stringify!($name), "(), false); ```"), pub fn $name(&self) -> bool { self.$name } } doc_comment::doc_comment! { concat!("Sets the value of the \"", stringify!($name), "\" refresh kind to `true`. ``` use sysinfo::RefreshKind; let r = RefreshKind::new(); assert_eq!(r.", stringify!($name), "(), false); let r = r.with_", stringify!($name), "(); assert_eq!(r.", stringify!($name), "(), true); ```"), pub fn $with(mut self) -> RefreshKind { self.$name = true; self } } doc_comment::doc_comment! { concat!("Sets the value of the \"", stringify!($name), "\" refresh kind to `false`. ``` use sysinfo::RefreshKind; let r = RefreshKind::everything(); assert_eq!(r.", stringify!($name), "(), true); let r = r.without_", stringify!($name), "(); assert_eq!(r.", stringify!($name), "(), false); ```"), pub fn $without(mut self) -> RefreshKind { self.$name = false; self } } }; } /// Used to determine what you want to refresh specifically on [`System`] type. /// /// ``` /// use sysinfo::{RefreshKind, System, SystemExt}; /// /// // We want everything except disks. /// let mut system = System::new_with_specifics(RefreshKind::everything().without_disks_list()); /// /// assert_eq!(system.get_disks().len(), 0); /// assert!(system.get_processes().len() > 0); /// ``` /// /// [`System`]: crate::System #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] pub struct RefreshKind { networks: bool, networks_list: bool, processes: bool, disks_list: bool, disks: bool, memory: bool, cpu: bool, components: bool, components_list: bool, users_list: bool, } impl RefreshKind { /// Creates a new `RefreshKind` with every refresh set to `false`. /// /// ``` /// use sysinfo::RefreshKind; /// /// let r = RefreshKind::new(); /// /// assert_eq!(r.networks(), false); /// assert_eq!(r.networks_list(), false); /// assert_eq!(r.processes(), false); /// assert_eq!(r.disks_list(), false); /// assert_eq!(r.disks(), false); /// assert_eq!(r.memory(), false); /// assert_eq!(r.cpu(), false); /// assert_eq!(r.components(), false); /// assert_eq!(r.components_list(), false); /// assert_eq!(r.users_list(), false); /// ``` pub fn new() -> RefreshKind { RefreshKind::default() } /// Creates a new `RefreshKind` with every refresh set to `true`. /// /// ``` /// use sysinfo::RefreshKind; /// /// let r = RefreshKind::everything(); /// /// assert_eq!(r.networks(), true); /// assert_eq!(r.networks_list(), true); /// assert_eq!(r.processes(), true); /// assert_eq!(r.disks_list(), true); /// assert_eq!(r.disks(), true); /// assert_eq!(r.memory(), true); /// assert_eq!(r.cpu(), true); /// assert_eq!(r.components(), true); /// assert_eq!(r.components_list(), true); /// assert_eq!(r.users_list(), true); /// ``` pub fn everything() -> RefreshKind { RefreshKind { networks: true, networks_list: true, processes: true, disks: true, disks_list: true, memory: true, cpu: true, components: true, components_list: true, users_list: true, } } impl_get_set!(networks, with_networks, without_networks); impl_get_set!(networks_list, with_networks_list, without_networks_list); impl_get_set!(processes, with_processes, without_processes); impl_get_set!(disks, with_disks, without_disks); impl_get_set!(disks_list, with_disks_list, without_disks_list); impl_get_set!(memory, with_memory, without_memory); impl_get_set!(cpu, with_cpu, without_cpu); impl_get_set!(components, with_components, without_components); impl_get_set!( components_list, with_components_list, without_components_list ); impl_get_set!(users_list, with_users_list, without_users_list); } /// Iterator over network interfaces. /// /// It is returned by [`Networks::iter`][crate::Networks#method.iter]. /// /// ```no_run /// use sysinfo::{System, SystemExt, NetworksExt}; /// /// let system = System::new_all(); /// let networks_iter = system.get_networks().iter(); /// ``` pub struct NetworksIter<'a> { inner: std::collections::hash_map::Iter<'a, String, NetworkData>, } impl<'a> NetworksIter<'a> { pub(crate) fn new(v: std::collections::hash_map::Iter<'a, String, NetworkData>) -> Self { NetworksIter { inner: v } } } impl<'a> Iterator for NetworksIter<'a> { type Item = (&'a String, &'a NetworkData); fn next(&mut self) -> Option<Self::Item> { self.inner.next() } } impl<'a> IntoIterator for &'a Networks { type Item = (&'a String, &'a NetworkData); type IntoIter = NetworksIter<'a>; fn into_iter(self) -> Self::IntoIter { self.iter() } } /// Enum containing the different supported disks types. /// /// This type is returned by [`Disk::get_type`][crate::Disk#method.get_type]. /// /// ```no_run /// use sysinfo::{System, SystemExt, DiskExt}; /// /// let system = System::new_all(); /// for disk in system.get_disks() { /// println!("{:?}: {:?}", disk.get_name(), disk.get_type()); /// } /// ``` #[derive(Debug, PartialEq, Clone, Copy)] pub enum DiskType { /// HDD type. HDD, /// SSD type. SSD, /// Removable disk. Removable, /// Unknown type. Unknown(isize), } /// An enum representing signal on UNIX-like systems. #[repr(C)] #[derive(Clone, PartialEq, PartialOrd, Debug, Copy)] pub enum Signal { /// Hangup detected on controlling terminal or death of controlling process. Hangup = 1, /// Interrupt from keyboard. Interrupt = 2, /// Quit from keyboard. Quit = 3, /// Illegal instruction. Illegal = 4, /// Trace/breakpoint trap. Trap = 5, /// Abort signal from C abort function. Abort = 6, // IOT trap. A synonym for SIGABRT. // IOT = 6, /// Bus error (bad memory access). Bus = 7, /// Floating point exception. FloatingPointException = 8, /// Kill signal. Kill = 9, /// User-defined signal 1. User1 = 10, /// Invalid memory reference. Segv = 11, /// User-defined signal 2. User2 = 12, /// Broken pipe: write to pipe with no readers. Pipe = 13, /// Timer signal from C alarm function. Alarm = 14, /// Termination signal. Term = 15, /// Stack fault on coprocessor (unused). Stklft = 16, /// Child stopped or terminated. Child = 17, /// Continue if stopped. Continue = 18, /// Stop process. Stop = 19, /// Stop typed at terminal. TSTP = 20, /// Terminal input for background process. TTIN = 21, /// Terminal output for background process. TTOU = 22, /// Urgent condition on socket. Urgent = 23, /// CPU time limit exceeded. XCPU = 24, /// File size limit exceeded. XFSZ = 25, /// Virtual alarm clock. VirtualAlarm = 26, /// Profiling time expired. Profiling = 27, /// Windows resize signal. Winch = 28, /// I/O now possible. IO = 29, // Pollable event (Sys V). Synonym for IO //Poll = 29, /// Power failure (System V). Power = 30, /// Bad argument to routine (SVr4). Sys = 31, } /// A struct representing system load average value. /// /// It is returned by [`SystemExt::get_load_average`][crate::SystemExt::get_load_average]. /// /// ```no_run /// use sysinfo::{System, SystemExt}; /// /// let s = System::new_all(); /// let load_avg = s.get_load_average(); /// println!( /// "one minute: {}%, five minutes: {}%, fifteen minutes: {}%", /// load_avg.one, /// load_avg.five, /// load_avg.fifteen, /// ); /// ``` #[repr(C)] #[derive(Default, Debug, Clone)] pub struct LoadAvg { /// Average load within one minute. pub one: f64, /// Average load within five minutes. pub five: f64, /// Average load within fifteen minutes. pub fifteen: f64, } /// Type containing user information. /// /// It is returned by [`SystemExt::get_users`][crate::SystemExt::get_users]. /// /// ```no_run /// use sysinfo::{System, SystemExt}; /// /// let s = System::new_all(); /// println!("users: {:?}", s.get_users()); /// ``` #[derive(PartialEq, Eq, PartialOrd, Ord, Debug)] pub struct User { pub(crate) name: String, pub(crate) groups: Vec<String>, } impl UserExt for User { fn get_name(&self) -> &str { &self.name } fn get_groups(&self) -> &[String] { &self.groups } } /// Type containing read and written bytes. /// /// It is returned by [`ProcessExt::disk_usage`][crate::ProcessExt::disk_usage]. /// /// ```no_run /// use sysinfo::{ProcessExt, System, SystemExt}; /// /// let s = System::new_all(); /// for (pid, process) in s.get_processes() { /// let disk_usage = process.disk_usage(); /// println!("[{}] read bytes : new/total => {}/{} B", /// pid, /// disk_usage.read_bytes, /// disk_usage.total_read_bytes, /// ); /// println!("[{}] written bytes: new/total => {}/{} B", /// pid, /// disk_usage.written_bytes, /// disk_usage.total_written_bytes, /// ); /// } /// ``` #[derive(Debug, Default, Clone, Copy, PartialEq, PartialOrd)] pub struct DiskUsage { /// Total number of written bytes. pub total_written_bytes: u64, /// Number of written bytes since the last refresh. pub written_bytes: u64, /// Total number of read bytes. pub total_read_bytes: u64, /// Number of read bytes since the last refresh. pub read_bytes: u64, }