runtime-environment

Crates.ioruntime-environment
lib.rsruntime-environment
version0.1.0
sourcesrc
created_at2024-06-07 15:30:05.736851
updated_at2024-06-07 15:30:05.736851
descriptionA rust library to check the runtime-environment at runtime
homepage
repositoryhttps://github.com/DhanushNehru/runtime-environment
max_upload_size
id1264927
size6,167
Dhanush (DhanushNehru)

documentation

README

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

Commit count: 8

cargo fmt