https://github.com/vv9k/rsys

Crate for gathering operating system information in os-agnostic way 🦀
https://github.com/vv9k/rsys

Last synced: 3 months ago
JSON representation

Crate for gathering operating system information in os-agnostic way 🦀

• Host: GitHub
• URL: https://github.com/vv9k/rsys
• Owner: vv9k
• License: mit
• Created: 2020-09-16T12:06:27.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-29T18:31:08.000Z (about 3 years ago)
• Last Synced: 2024-04-24T04:52:32.594Z (6 months ago)
• Language: Rust
• Homepage:
• Size: 365 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rsys

[![master](https://github.com/wojciechkepka/rsys/actions/workflows/master.yml/badge.svg)](https://github.com/wojciechkepka/rsys/actions/workflows/master.yml)

[![crates.io](https://img.shields.io/crates/v/rsys)](https://crates.io/crates/rsys)

[![crates.io](https://img.shields.io/crates/l/rsys)](https://github.com/wojciechkepka/rsys/blob/master/LICENSE)

[![Docs](https://img.shields.io/badge/docs-master-brightgreen)](https://docs.rs/rsys)  

Crate for aquiring information about host machine and operating system

in a os-agnostic fashion.  

 

The common api is available through Rsys struct which compiles conditionally with

required methods. The error and result type is available at the root of this crate for convienience

while all the methods exposed by Rsys struct are also available in each os module.  

Main goals are clear and easy api with as much of the api being os-agnostic.

  

## Example usage:

- `Cargo.toml`

```toml

[dependencies]

rsys = "0.5"

```

- `main.rs`

```rust

use rsys::{Result, Rsys};

fn main() -> Result<()> {

    // You can either use api through Rsys object

    // for os-agnostic experience

    let rsys = Rsys::new();

    println!("HOSTNAME - {}", rsys.hostname()?);

    println!("CPU - {}", rsys.cpu()?);

    println!("CPU CORES - {}", rsys.cpu_cores()?);

    println!("CPU CLOCK - {}MHz", rsys.cpu_clock()?);

    println!("UPTIME - {}s", rsys.uptime()?);

    println!("ARCH - {}", rsys.arch()?);

    println!("SWAP TOTAL - {}b", rsys.swap_total()?);

    println!("SWAP FREE - {}b", rsys.swap_free()?);

    println!("MEMORY TOTAL - {}b", rsys.memory_total()?);

    println!("MEMORY FREE - {}b", rsys.memory_free()?);

    #[cfg(target_os = "linux")]

    {

        // Or use functions in each module

        println!("KERNEL VERSION - {}", rsys::linux::kernel_release()?);

        

        // Os-specific functions are also available as methods

        println!("KERNEL_VERSION - {}", rsys.kernel_release()?);

        println!("{:#?}", rsys.pids()?);

        println!("MOUNTS - {:#?}", rsys::linux::mounts::mounts()?);

    }

    Ok(())

}

```

## TODO

 - [ ] Finish macos common api

 - [ ] Finish windows common api

 - [ ] Add async feature for async file reads and commands etc...

## License

[**MIT**](https://gitlab.com/vvvxxx/rsys/-/blob/master/LICENSE)