uni_error 0.11.3

A simple, universal error type for Rust
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
47
48
49
50
51
52
53
54
55

#![forbid(unsafe_code)]
#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! A simple, universal error type for Rust

extern crate alloc;

/// Module to analyze the cause chain of an error.
pub mod cause;
/// Module for converting between error types.
pub mod convert;
mod error;
mod inner;
mod kind;
#[doc = include_str!("../README.md")]
mod readme_tests {}

pub use cause::Cause;
pub use convert::{
    ErrorContext, ErrorContextDisplay, ResultContext, ResultContextDisplay, UniResultContext,
    UniResultContextModify,
};
pub use error::*;
pub use kind::*;

// *** Type aliases ***

/// A result type that specifies a customkind.
pub type UniResult<T, K> = Result<T, UniError<K>>;

/// An error type that is used when there is no kind.
pub type SimpleError = UniError<()>;

/// A result type that specifies no kind.
pub type SimpleResult<T> = Result<T, SimpleError>;

/// A dynamic error type that specifies a dynamic kind.
pub type DynError = UniError<dyn UniKind>;

/// A result type that specifies a dynamic kind.
pub type DynResult<T> = Result<T, DynError>;

/// A dynamic error type that specifies a dynamic kind and code.
pub type DynCodeError<C> = UniError<dyn UniKindCode<Code = C>>;

/// A result type that specifies a dynamic kind and code.
pub type DynCodeResult<T, C> = Result<T, DynCodeError<C>>;

/// A dynamic error type that specifies a dynamic kind and two codes.
pub type DynCodesError<C, C2> = UniError<dyn UniKindCodes<Code = C, Code2 = C2>>;

/// A result type that specifies a dynamic kind and two codes.
pub type DynCodesResult<T, C, C2> = Result<T, DynCodesError<C, C2>>;