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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/*
.. + lib.rs + ..
Copyright 2021 Hwakyeom Kim(=just-do-halee)
*/
//! First, You should make your own an error set.
//! # Example
//! ```ignore
//! err! {
//! BrokenHeader => "broken header."
//! AnotherHeader => "not matched header."
//! FileNotFound => "file not found."
//! EmptyArgument => "empty argument."
//! UnexpectedEof => "unexpected eof."
//! OutOfBounds => "index out of bounds."
//! NotMatched => "btw not matched."
//! }
//! ```
//! And just errbang!
//! ```ignore
//! errbang!(err::BrokenHeader);
//! ```
//! # More Examples
//! ```ignore
//! fn foo() -> Result<bool> { // Our Master Result Type
//! let bar = 2;
//! match bar {
//! 0 => Ok(true),
//! 1 => Ok(false),
//! _ => errbang!(err::NotMatched, "{} is {}", "bar", bar),
//! }
//! }
//! fn main() -> Result<()> {
//! let _is_bar_zero = foo()?;
//! Ok(())
//! }
//! ```
//! ```ignore
//! errbang!("error.");
//! errbang!(err::MyError1);
//! errbang!(err::MyError2, "cannot find.");
//! errbang!(err::MyError3, "{} is {}", "bar", 2);
//! ```
//!
//! | Result
//! ```text
//! [src/main.rs 40:1] unexpected eof. bar is 2 <err::UnexpectedEof>
//! ```
//!
//! unwrapping error input data. also can easily compare them.
//! ```ignore
//! fn foo() -> Result<()> {
//! // example
//! return errbang!(err::Bar, "this is input.");
//! }
//!
//! assert_eq!(
//! errunwrap!(foo(), err::Bar), "this is input."
//! );
//! ```
//!
//! # ***Important***
//!
//! - 1. One result type(`anyhow`).
//! - 2. All casted errors have their own chaining error' information(all the previous errors).
//!
//! if you follow below rules, you can easily debug all your projects.
//!
//! ### errbang -> errcast -> errcast -> ... -> errcast -> errextract
//!
//! ---
//!
//! ## Quick Overview
//!
//! ```ignore
//! use utils_results::*;
//!
//! err! {
//! One => "this error is first one."
//! Two => "this error is second one."
//! Three => "this error is third one."
//! Well => "is this?"
//! }
//!
//!
//! fn aaa() -> Result<usize> {
//! return errbang!(err::One, "{}.error bang!", 1);
//! }
//!
//! fn bbb() -> Result<usize> {
//! let n = errcast!(aaa(), err::Two, "{}.two <- one.", 2);
//! Ok(n)
//! }
//!
//! fn ccc() -> Result<usize> {
//! Ok(errcast!(bbb(), err::Three, "{}.three <- two.", n))
//! }
//!
//!
//! fn main() -> Result<()> {
//! let c = errextract!(ccc(), err::Well => 127);
//! eprintln!("1/{} is cosmological constant.", c);
//! Ok(())
//! }
//! ```
//!
//! | Result
//! ```text
//! Error:
//! [src/main.rs 11:12] this error is first one. 1.error bang! <err::One> aaa()
//! ⎺↴
//! [src/main.rs 14:13] this error is second one. 2.two <- one. <err::Two> bbb()
//! ⎺↴
//! [src/main.rs 18:8] this error is third one. 3.three <- two. <err::Three>
//! ```
//! If the matching error be changed,
//! ```ignore
//! // Well to Three
//! let c = errextract!(ccc(), err::Three => 127);
//! ```
//! | Result
//! ```text
//! 1/127 is cosmological constant.
//! ```
//!
//! ---
//!
//! # ***errcast***
//! Any type of error can be converted into our Master Error.
//!
//!
//! ```ignore
//! // example
//! // <Unwraped Ok> = errcast!(<Any Result>, <Master Err>, <Optional,..>);
//! let num_read = errcast!(file.read(&mut buf), err::ReadErr, "this is {} data.", "meta");
//! ```
//! ---
//! # Simply just do this!
//!
//! ```ignore
//! let file = errcast!(File::open("test"), err::FileOpenError)
//! ```
//! ## or...
//! ```ignore
//! // Master `Result` can take any errors
//! let file = File::open("test")?;
//!
//! // if cfg!(no_std),
//! let file = io_to_err!(File::open("test"))?;
//! ```
//! But, *errcast* -> ***errextract*** combo is always good choice.
//!
//! ```ignore
//! fn exe(path: &str) -> Result<usize> {
//! let file = errcast!(File::open("test"), err::FileOpenError);
//! // .....
//! // ...
//! Ok(num)
//! }
//!
//! fn main() -> Result<()> {
//! /// non panic unwraping
//! /// and specific error can return
//! /// matching block
//! let num = errextract!(exe(path),
//! err::FileOpenError => 0);
//! /// other errors will go out -> Result<T>
//!
//! Ok(())
//! }
//! ```
//! ---
//! # ***Master Result***
//! * Please use our Master ***Result***\<T\>
//! instead std::result::Result or io::Result etc..
//! * this is `anyhow` Result.<br>
//! ---
//! ###### ***utils-results/lib.rs*** Definition
//! ```ignore
//! /// Master Result
//! pub type Result<T> = anyhow::Result<T>;
//! ```
//! ---
//! ### just put this in your project.
//! ```ignore
//! pub use utils_results::*;
//! ```
//! ## You can also convert any type of `Result`
//! ```ignore
//! // to our Master Result
//! resultcast!(handle.join().unwrap())?;
//! ```
#![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
extern crate anyhow;
/// Master Result
pub use anyhow::{Error, Result};
#[macro_use]
mod macros;
extern crate alloc;
#[doc(hidden)]
pub mod private {
pub use alloc::{format, string::String};
pub use anyhow::{Error, Result};
#[cfg(not(feature = "std"))]
pub use core::fmt;
#[cfg(feature = "std")]
pub use std::fmt;
}