w32-error

Crates.iow32-error
lib.rsw32-error
version1.0.0
sourcesrc
created_at2020-03-31 05:01:06.292388
updated_at2020-03-31 05:01:06.292388
descriptionEncapsulates Windows API error codes.
homepage
repositoryhttps://github.com/FaultyRAM/w32-error
max_upload_size
id224656
size26,101
(FaultyRAM)

documentation

README

w32-error

Travis CI Crates.io Docs.rs

w32-error is a Rust crate for encapsulating Windows API error codes. It provides the W32Error type, a thin wrapper over a DWORD with trait implementations for error handling.

Features

  • #![no_std]-friendly - almost all of w32-error is available to #![no_std] crates. Parts that require libstd (Error trait impl, conversion to/from io::Error) are kept behind an opt-in feature gate.
  • Zero overhead - W32Error is guaranteed to have the same layout as a DWORD. Display::fmt doesn't access the heap; instead, it uses a small buffer on the stack to receive error messages.

Usage

To use w32-error, simply add it to your Cargo.toml.

By default, w32-error is configured for a #![no_std] environment:

[dependencies]
w32-error = "^1.0.0"

Alternatively, features that require libstd can be manually enabled:

[dependencies]
w32-error = { version = "^1.0.0", features = ["std"] }

For more details, see the API documentation.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 21

cargo fmt