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
|
# errno [](https://github.com/lambda-fairy/rust-errno/actions/workflows/main.yml) [](https://crates.io/crates/errno)
Cross-platform interface to the [`errno`][errno] variable. Works on Rust 1.56 or newer.
Documentation is available at <https://docs.rs/errno>.
[errno]: https://en.wikipedia.org/wiki/Errno.h
## Dependency
Add to your `Cargo.toml`:
```toml
[dependencies]
errno = "*"
```
## Comparison with `std::io::Error`
The standard library provides [`Error::last_os_error`][last_os_error] which fetches `errno` in the same way.
This crate provides these extra features:
- No heap allocations
- Optional `#![no_std]` support
- A `set_errno` function
[last_os_error]: https://doc.rust-lang.org/std/io/struct.Error.html#method.last_os_error
## Examples
```rust
extern crate errno;
use errno::{Errno, errno, set_errno};
// Get the current value of errno
let e = errno();
// Set the current value of errno
set_errno(e);
// Extract the error code as an i32
let code = e.0;
// Display a human-friendly error message
println!("Error {}: {}", code, e);
```
## `#![no_std]`
Enable `#![no_std]` support by disabling the default `std` feature:
```toml
[dependencies]
errno = { version = "*", default-features = false }
```
The `Error` impl will be unavailable.
|