error-repr 0.1.1

Generalization of std::io::Error
Documentation 
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

#![cfg_attr(not(any(feature = "std", test)), no_std)]
#![cfg_attr(feature = "nightly-io_error_more", feature(io_error_more, io_error_inprogress))]

#![deny(missing_docs)]
//! A crate that generlizes the API surface of [`std::io::Error`] by providing a type that wraps an error kind and a payload.
//!
//! ## Features
//! * `alloc`: Adds support for interfaces that require an allocator. In particular, this adds error constructors that take arbitrary payloads.
//! * `std`: Adds support for interfaces that require the standard library (conversions to and from [`std::io::Error`] and an implementing [`kind::ErrorKind`] for [`std::io::ErrorKind`]).
//! * `error-track_caller`: Causes construction of [`Error`] to carry information about the location they were created.
//!     This is a debugging tool only - it does not add any API interfaces to the crate. Instead, the error simply holds the information internally, which is shown in the [`core::fmt::Debug`] impl.
//!
//!
#![cfg_attr(
    all(not(feature = "std"), doc),
    doc = "[`std::io::Error`]: <https://doc.rust-lang.org/std/io/struct.Error.html>"
)]
#![cfg_attr(
    all(not(feature = "std"), doc),
    doc = "[`std::io::ErrorKind`]: <https://doc.rust-lang.org/std/io/enum.ErrorKind.html>"
)]

mod error;
/// Module for the [`ErrorKind`][kind::ErrorKind] trait and support traits.
pub mod kind;

pub use error::Error;

#[cfg(feature = "alloc")]
extern crate alloc;

cfg_match::cfg_match! {
    any(target_os = "lilium") => {
        /// The raw type of an OS Error.
        /// On most targets, this is `i32`, but on other targets it may be `isize` or another integer type
        pub type RawOsError = isize;
    }
    _ => {
        /// The raw type of an OS Error.
        /// On most targets, this is `i32`, but on other targets it may be `isize` or another integer type
        pub type RawOsError = i32;
    }
}

#[cfg(feature = "os-error-wrapper")]
pub mod os;