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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
//! This module contains all the traits and types for creating a cross-platform API to query
//! different readouts from various operating systems. For each operating system, there must be an implementation of these traits.
#![allow(unused_variables)]
use byte_unit::AdjustedByte;
/// This enum contains possible error types when doing sensor & variable readouts.
#[derive(Debug, Clone)]
pub enum ReadoutError {
/// A specific metric might not be available on all systems (e. g. battery percentage on a
/// desktop). \
/// If you encounter this error, it means that the requested value is not available.
MetricNotAvailable,
/// A readout for a metric might be available, but fails due to missing dependencies or other
/// unsatisfied requirements.
Other(String),
/// Getting a readout on a specific operating system might not make sense or causes some other
/// kind of warning. This is not necessarily an error.
Warning(String),
}
impl ToString for ReadoutError {
fn to_string(&self) -> String {
match self {
ReadoutError::MetricNotAvailable => {
String::from("Metric is not available on this system.")
}
ReadoutError::Other(s) => s.clone(),
ReadoutError::Warning(s) => s.clone(),
}
}
}
impl From<&ReadoutError> for ReadoutError {
fn from(r: &ReadoutError) -> Self {
r.to_owned()
}
}
lazy_static! {
static ref STANDARD_NO_IMPL: ReadoutError = ReadoutError::Warning(String::from(
"This metric is not available on this platform or is not yet implemented by Macchina."
));
}
/**
This trait provides the necessary functions for querying battery statistics from the host
computer. A desktop computer might not be able to provide values such as `percentage` and
`status`, which means a `ReadoutError` can be returned.
# Example
```
use libmacchina::traits::BatteryReadout;
use libmacchina::traits::ReadoutError;
use libmacchina::traits::BatteryState;
//You can add fields to this struct which will then need to be initialized in the
//BatteryReadout::new() function.
pub struct MacOSBatteryReadout;
impl BatteryReadout for MacOSBatteryReadout {
fn new() -> Self {
MacOSBatteryReadout {}
}
fn percentage(&self) -> Result<u8, ReadoutError> {
//get the battery percentage somehow...
Ok(100u8) //always fully charged
}
fn status(&self) -> Result<BatteryState, ReadoutError> {
//check if battery is being charged...
Ok(BatteryState::Charging) //always charging.
}
}
```
*/
pub trait BatteryReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function is used for querying the current battery percentage. The expected value is
/// a u8 in the range of `0` to `100`.
fn percentage(&self) -> Result<u8, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function is used for querying the current battery charging state. If the battery is
/// currently being charged, we expect a return value of `BatteryState::Charging`, otherwise
/// `BatteryState::Discharging`.
fn status(&self) -> Result<BatteryState, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function is used for querying the current battery's health in percentage.
fn health(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
}
/**
This trait is used for implementing common functions for reading kernel properties, such as
kernel name and version.
# Example
```
use libmacchina::traits::KernelReadout;
use libmacchina::traits::ReadoutError;
pub struct MacOSKernelReadout;
impl KernelReadout for MacOSKernelReadout {
fn new() -> Self {
MacOSKernelReadout {}
}
fn os_release(&self) -> Result<String, ReadoutError> {
// Get kernel version
Ok(String::from("20.0.1"))
}
fn os_type(&self) -> Result<String, ReadoutError> {
// Get kernel name
Ok(String::from("Darwin"))
}
}
```
*/
pub trait KernelReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function should return the version of the kernel (e. g. `20.3.0` on macOS for Darwin).
fn os_release(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the kernel name as a string (e. g. `Darwin` on macOS).
fn os_type(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function is used for getting the kernel name and version in a pretty format.
fn pretty_kernel(&self) -> Result<String, ReadoutError> {
let os_type = self.os_type().unwrap_or_default();
let os_release = self.os_release().unwrap_or_default();
if !(os_type.is_empty() || os_release.is_empty()) {
return Ok(format!("{} {}", os_type, os_release));
}
Err(ReadoutError::MetricNotAvailable)
}
}
/**
This trait provides common functions for _querying the current memory state_ of the host
device, most notably `free` and `used`.
# Example
```
use libmacchina::traits::MemoryReadout;
use libmacchina::traits::ReadoutError;
pub struct MacOSMemoryReadout;
impl MemoryReadout for MacOSMemoryReadout {
fn new() -> Self {
MacOSMemoryReadout {}
}
fn total(&self) -> Result<u64, ReadoutError> {
// Get the total physical memory for the machine
Ok(512 * 1024) // Return 512mb in kilobytes.
}
fn used(&self) -> Result<u64, ReadoutError> {
// Get the currently used memory.
Ok(256 * 1024) // Return 256mb in kilobytes.
}
}
```
*/
pub trait MemoryReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function should return the total available memory in kilobytes.
fn total(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the free available memory in kilobytes.
fn free(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the current memory value for buffers in kilobytes.
fn buffers(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the amount of cached content in memory in kilobytes.
fn cached(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the amount of reclaimable memory in kilobytes.
fn reclaimable(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the amount of currently used memory in kilobytes.
fn used(&self) -> Result<u64, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
}
/**
This trait provides the interface for implementing functionality used for _counting packages_ on
the host system. Almost all modern operating systems use some kind of package manager.
# Example
```
use libmacchina::traits::{PackageReadout, PackageManager};
use libmacchina::traits::ReadoutError;
pub struct MacOSPackageReadout;
impl PackageReadout for MacOSPackageReadout {
fn new() -> Self {
MacOSPackageReadout {}
}
fn count_pkgs(&self) -> Vec<(PackageManager, usize)> {
// Check if homebrew 🍻 is installed and count installed packages...
vec![(PackageManager::Homebrew, 120)]
}
}
```
*/
pub trait PackageReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function should return the number of installed packages.
fn count_pkgs(&self) -> Vec<(PackageManager, usize)> {
Vec::new()
}
}
/**
This trait provides the interface for implementing functionality used for getting _product information_
about the hosts operating system.
# Example
```
use libmacchina::traits::ProductReadout;
use libmacchina::traits::ReadoutError;
pub struct MacOSProductReadout;
impl ProductReadout for MacOSProductReadout {
fn new() -> Self {
MacOSProductReadout {}
}
fn vendor(&self) -> Result<String, ReadoutError> {
Ok(String::from("Apple"))
}
fn family(&self) -> Result<String, ReadoutError> {
Ok(String::from("Unix, Macintosh"))
}
fn name(&self) -> Result<String, ReadoutError> {
// Get name of os release...
Ok(String::from("Big Sur"))
}
fn product(&self) -> Result<String, ReadoutError> {
Ok(String::from("macOS"))
}
}
```
*/
pub trait ProductReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function should return the version of the host's machine.
///
/// _e.g._ `Lenovo IdeaPad S540-15IWL GTX`
///
/// This is set by the machine's manufacturer.
fn version(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the vendor name of the host's machine.
///
/// _e.g._ `Lenovo`
///
/// This is set by the machine's manufacturer.
fn vendor(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the family name of the host's machine.
///
/// _e.g._ `IdeaPad S540-15IWL GTX`
///
/// This is set by the machine's manufacturer.
fn family(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the host's machine.
///
/// _e.g._ `81SW`
///
/// This is set by the machine's manufacturer.
fn name(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the product name of the hosts machine.
///
/// _e.g._ `IdeaPad S540-15IWL GTX`
///
/// This is set by the machine's manufacturer.
fn product(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
}
/**
This trait provides the interface for implementing functionality used for querying general
information about the running operating system and current user.
# Example
```
use libmacchina::traits::GeneralReadout;
use libmacchina::traits::ReadoutError;
pub struct MacOSGeneralReadout;
impl GeneralReadout for MacOSGeneralReadout {
fn new() -> Self {
MacOSGeneralReadout {}
}
fn username(&self) -> Result<String, ReadoutError> {
//let username = NSUserName();
Ok(String::from("johndoe"))
}
// Implement other trait functions...
}
```
*/
pub trait GeneralReadout {
/// Creates a new instance of the structure which implements this trait.
fn new() -> Self;
/// This function should return the backlight (brightness) value of the machine.
///
/// _e.g._ `100`
fn backlight(&self) -> Result<usize, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the display resolution of the machine.
///
/// _e.g. `1920x1080`
fn resolution(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the username of the currently logged on user.
///
/// _e.g._ `johndoe`
fn username(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the hostname of the host's computer.
///
/// _e.g._ `supercomputer`
fn hostname(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the distribution of the operating system.
///
/// _e.g._ `Arch Linux`
fn distribution(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the user's local ip address
///
/// _e.g._ `192.168.1.11`
fn local_ip(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the used desktop environment.
///
/// _e.g._ `Plasma`
fn desktop_environment(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the used window manager.
///
/// _e.g._ `KWin`
fn window_manager(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the used terminal emulator.
///
/// _e.g._ `kitty`
fn terminal(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/**
This function should return the currently running shell depending on the `_shorthand` value.
- If `_shorthand` is `ShellFormat::Relative` the basename of the shell will be returned.
_e.g._ bash, zsh, etc.
- If `_shorthand` is `ShellFormat::Absolute` the absolute path of the shell will be returned.
_e.g._ /bin/bash, /bin/zsh, etc.
*/
fn shell(&self, _shorthand: ShellFormat, kind: ShellKind) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the model name of the CPU \
///
/// _e.g._ `Intel(R) Core(TM) i5-8265U CPU @ 1.60GHz`
fn cpu_model_name(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the average CPU usage over the last minute.
fn cpu_usage(&self) -> Result<usize, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the number of physical cores of the host's processor.
fn cpu_physical_cores(&self) -> Result<usize, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the number of logical cores of the host's processor.
fn cpu_cores(&self) -> Result<usize, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the uptime of the OS in seconds.
fn uptime(&self) -> Result<usize, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the physical machine.
///
/// _e.g._ `MacBookPro11,5`
fn machine(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the name of the OS in a pretty format.
///
/// _e.g._ `macOS 11.2.2 Big Sur`
fn os_name(&self) -> Result<String, ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
/// This function should return the used disk space in a human-readable and desirable format.
///
/// _e.g._ '1.2TB / 2TB'
fn disk_space(&self) -> Result<(AdjustedByte, AdjustedByte), ReadoutError> {
Err(STANDARD_NO_IMPL.clone())
}
}
/// Holds the possible variants for battery status.
pub enum BatteryState {
Charging,
Discharging,
}
impl From<BatteryState> for &'static str {
fn from(state: BatteryState) -> &'static str {
match state {
BatteryState::Charging => "Charging",
BatteryState::Discharging => "Discharging",
}
}
}
/// The currently running shell is a program, whose path
/// can be _relative_, or _absolute_.
#[derive(Debug)]
pub enum ShellFormat {
Relative,
Absolute,
}
#[derive(Debug)]
/// There are two distinct kinds of shells, a so called *"current"* shell, i.e. the shell the user is currently using.
/// And a default shell, i.e. that the user sets for themselves using the `chsh` tool.
pub enum ShellKind {
Current,
Default,
}
/// The supported package managers whose packages can be extracted.
pub enum PackageManager {
Homebrew,
MacPorts,
Pacman,
Portage,
Dpkg,
Opkg,
Xbps,
Pkgsrc,
Apk,
Eopkg,
Rpm,
Cargo,
Flatpak,
Snap,
Android,
}
impl ToString for PackageManager {
fn to_string(&self) -> String {
String::from(match self {
PackageManager::Homebrew => "Homebrew",
PackageManager::MacPorts => "MacPorts",
PackageManager::Pacman => "pacman",
PackageManager::Portage => "portage",
PackageManager::Dpkg => "dpkg",
PackageManager::Opkg => "opkg",
PackageManager::Xbps => "xbps",
PackageManager::Pkgsrc => "pkgsrc",
PackageManager::Apk => "apk",
PackageManager::Eopkg => "eopkg",
PackageManager::Rpm => "rpm",
PackageManager::Cargo => "cargo",
PackageManager::Flatpak => "flatpak",
PackageManager::Snap => "snap",
PackageManager::Android => "Android",
})
}
}