runtime-environment 0.1.0

A rust library to check the runtime-environment at runtime
Documentation
  • Coverage
  • 0%
    0 out of 4 items documented0 out of 3 items with examples
  • Size
  • Source code size: 5.86 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.03 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Links
  • DhanushNehru/runtime_environment
    1 1 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • DhanushNehru

runtime-environment

A Rust library to check the operating system at runtime.

Installation

In your Cargo.toml, add the following line under the [dependencies] section:

runtime-environment = "0.1.0"

Usage

This is an example usage someone might do:

use runtime-environment::{is_mac_os, is_windows, is_linux};

fn main() {
    if is_mac_os() {
        println!("Running on macOS");
    } else if is_windows() {
        println!("Running on Windows");
    } else if is_linux() {
        println!("Running on Linux");
    } else {
        println!("Running on an unknown OS");
    }
}

Functions

is_mac_os() -> bool

Returns true if the operating system is macOS.

is_windows() -> bool

Returns true if the operating system is Windows.

is_linux() -> bool

Returns true if the operating system is Linux.

Testing

To run the tests, use the following command:

cargo test

License

This project is licensed under the MIT License.

Replace "0.1.0" with the actual version number of your package when you publish it.

This README.md file provides a clear overview of the library, installation instructions, example usage, and information on the available functions.

Gitpod

In the cloud-free development runtime-environment where you can directly start coding.

You can use Gitpod in the cloud Gitpod Ready-to-Code


Feel free to update the README.md or raise issues if any to enhance the project