# rust_info
[](https://crates.io/crates/rust_info) [](https://github.com/sagiegurari/rust_info/actions) [](https://codecov.io/gh/sagiegurari/rust_info)<br>
[](https://github.com/sagiegurari/rust_info/blob/master/LICENSE) [](https://libraries.io/cargo/rust_info) [](https://docs.rs/crate/rust_info/) [](https://crates.io/crates/rust_info)<br>
[](https://sagiegurari.github.io/cargo-make)
> Extracts the current [rust](https://www.rust-lang.org/) compiler information.
* [Overview](#overview)
* [Usage](#usage)
* [Installation](#installation)
* [API Documentation](https://sagiegurari.github.io/rust_info/)
* [Contributing](.github/CONTRIBUTING.md)
* [Release History](CHANGELOG.md)
* [License](#license)
<a name="overview"></a>
## Overview
This library main goal is to provide development/build tools such as [cargo-make](https://sagiegurari.github.io/cargo-make/) the needed information on the current rust installation and setup.
<a name="usage"></a>
## Usage
Simply include the library and invoke the get function to pull all info as follows:
````rust
fn main() {
let rust_info = rust_info::get();
println!("Version: {}", rust_info.version.unwrap());
println!("Channel: {:#?}", rust_info.channel.unwrap());
println!("Target Arch: {}", rust_info.target_arch.unwrap_or("unknown".to_string()));
println!("Target Env: {}", rust_info.target_env.unwrap_or("unknown".to_string()));
println!("Target OS: {}", rust_info.target_os.unwrap_or("unknown".to_string()));
println!("Target Pointer Width: {}", rust_info.target_pointer_width.unwrap_or("unknown".to_string()));
println!("Target Vendor: {}", rust_info.target_vendor.unwrap_or("unknown".to_string()));
println!("Target Triple: {}", rust_info.target_triple.unwrap_or("unknown".to_string()));
}
````
<a name="installation"></a>
## Installation
In order to use this library, just add it as a dependency:
```ini
[dependencies]
rust_info = "^0.3.1"
```
## API Documentation
See full docs at: [API Docs](https://sagiegurari.github.io/rust_info/)
## Contributing
See [contributing guide](.github/CONTRIBUTING.md)
<a name="history"></a>
## Release History
See [Changelog](CHANGELOG.md)
<a name="license"></a>
## License
Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.