diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..5cde165 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +version: 2 +updates: +- package-ecosystem: cargo + directory: "/" + schedule: + interval: daily + open-pull-requests-limit: 10 diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml new file mode 100644 index 0000000..7dff904 --- /dev/null +++ b/.github/workflows/coverage.yml @@ -0,0 +1,38 @@ +name: coverage + +on: + # Trigger the workflow on push or pull request, + # but only for the master branch + push: + branches: + - master + pull_request: + branches: + - master + release: + types: + - created + + +jobs: + coverage: + runs-on: ubuntu-latest + env: + CARGO_TERM_COLOR: always + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@master + with: + target: x86_64-unknown-linux-gnu + toolchain: nightly + components: llvm-tools-preview + - name: Install cargo-llvm-cov + uses: taiki-e/install-action@cargo-llvm-cov + - name: Generate code coverage + run: cargo +nightly llvm-cov --all-features --workspace --codecov --doctests --output-path codecov.json + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos + files: codecov.json + fail_ci_if_error: true diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 36952c2..7062679 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -7,34 +7,19 @@ on: jobs: deploy: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - name: Set CURRENT_TWO_WEEKS for use in cache keys - run: echo "::set-env name=CURRENT_TWO_WEEKS::$(($(date +%V) / 2))" - - - name: Cache cargo registry - uses: actions/cache@v1 - with: - path: ~/.cargo/registry - key: ${{ runner.os }}-cargo-registry-${{ env.CURRENT_TWO_WEEKS }} - - - name: Cache cargo index - uses: actions/cache@v1 - with: - path: ~/.cargo/git - key: ${{ runner.os }}-cargo-index-${{ env.CURRENT_TWO_WEEKS }} - - - name: Cache mdbook binary - uses: actions/cache@v1 - with: - path: ~/.cargo/bin/mdbook - key: ${{ runner.os }}-cargo-mdbook-${{ env.CURRENT_TWO_WEEKS }} - - name: Build mdbook run: cargo install mdbook + - name: Build cargo-readme + run: cargo install cargo-readme + + - name: Build README.md + run: cargo readme > README.md + - name: Build run: mdbook build diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 312cbfd..3fc2545 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -1,15 +1,72 @@ name: Rust -on: [push] +on: + # Trigger the workflow on push or pull request, + # but only for the master branch + push: + branches: + - master + pull_request: + branches: + - master + release: + types: + - created jobs: build: - runs-on: ubuntu-latest - + strategy: + matrix: + version: + - 1.54.0 + - stable + - beta + - nightly steps: - - uses: actions/checkout@v2 - - name: Build - run: cargo build --verbose - - name: Run tests - run: cargo test --verbose + - uses: actions/checkout@v1 + - name: Install toolchain + uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.version }} + profile: minimal + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose + - name: Build --all-features + run: cargo build --verbose --all-features + - name: Run tests --all-features + run: cargo test --verbose --all-features + + fmt: + name: cargo fmt + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: dtolnay/rust-toolchain@master + with: + components: rustfmt + toolchain: stable + profile: minimal + override: true + - uses: actions-rs/cargo@v1 + with: + command: fmt + args: --all -- --check + + clippy: + name: cargo clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: dtolnay/rust-toolchain@master + with: + components: clippy + toolchain: stable + profile: minimal + override: true + - uses: actions-rs/cargo@v1 + with: + command: clippy + args: -- -D warnings diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index b39f048..0000000 --- a/.travis.yml +++ /dev/null @@ -1,22 +0,0 @@ -language: rust - -branches: - except: - - gh-pages - -rust: -- stable -- nightly - -os: -- linux -- windows - -script: -- cargo build --all -- cargo test --all - -matrix: - allow_failures: - - rust: nightly - fast_finish: true diff --git a/Cargo.toml b/Cargo.toml index 327757b..59b8808 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,9 @@ [package] name = "chainerror" -version = "0.5.0" +version = "1.0.0" authors = ["Harald Hoyer "] edition = "2018" -license = "MIT/Apache-2.0" +license = "MIT OR Apache-2.0" documentation = "https://docs.rs/chainerror" homepage = "https://haraldh.github.io/chainerror/" repository = "https://github.com/haraldh/chainerror" @@ -16,10 +16,11 @@ exclude = [ ".gitignore", "examples/*", "booksrc/*", "book.toml", "theme/*", "git-deploy-branch.sh", ".travis.yml" ] [badges] -travis-ci = { repository = "haraldh/chainerror" } +# See https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section +github = { repository = "haraldh/chainerror", workflow = "Rust" } +maintenance = { status = "actively-developed" } +is-it-maintained-issue-resolution = { repository = "haraldh/chainerror" } +is-it-maintained-open-issues = { repository = "haraldh/chainerror" } -[features] -default = [ ] -no-fileline = [] -display-cause = [] -no-debug-cause = [] +[package.metadata.docs.rs] +cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"] diff --git a/README.md b/README.md index 9252c1d..3a46567 100644 --- a/README.md +++ b/README.md @@ -1,129 +1,186 @@ -# chainerror - -[![Build Status](https://travis-ci.org/haraldh/chainerror.svg?branch=master)](https://travis-ci.org/haraldh/chainerror) [![Crate](https://img.shields.io/crates/v/chainerror.svg)](https://crates.io/crates/chainerror) [![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/chainerror/) +[![Coverage Status](https://codecov.io/gh/haraldh/chainerror/branch/master/graph/badge.svg?token=HGLJFGA11B)](https://codecov.io/gh/haraldh/chainerror) +![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg) -`chainerror` provides an error backtrace like `failure` without doing a real backtrace, so even after you `strip` your +# chainerror + +`chainerror` provides an error backtrace without doing a real backtrace, so even after you `strip` your binaries, you still have the error backtrace. -`chainerror` has no dependencies! +Having nested function returning errors, the output doesn't tell where the error originates from. -`chainerror` uses `.source()` of `std::error::Error` along with `line()!` and `file()!` to provide a nice debug error backtrace. -It encapsulates all types, which have `Display + Debug` and can store the error cause internally. +```rust +use std::path::PathBuf; -Along with the `ChainError` struct, `chainerror` comes with some useful helper macros to save a lot of typing. - -Debug information is worth it! - -Now continue reading the -[Tutorial](https://haraldh.github.io/chainerror/tutorial1.html) - -## Example: -Output: - -~~~ -$ cargo run -q --example example -Main Error Report: func1 error calling func2 - -Error reported by Func2Error: func2 error: calling func3 - -The root cause was: std::io::Error: Kind( - NotFound -) - -Debug Error: -examples/example.rs:45: func1 error calling func2 -Caused by: -examples/example.rs:20: Func2Error(func2 error: calling func3) -Caused by: -examples/example.rs:13: Error reading 'foo.txt' -Caused by: -Kind(NotFound) -~~~ - -~~~rust,ignore -use chainerror::*; -use std::error::Error; -use std::io; -use std::result::Result; - -fn do_some_io() -> Result<(), Box> { - Err(io::Error::from(io::ErrorKind::NotFound))?; +type BoxedError = Box; +fn read_config_file(path: PathBuf) -> Result<(), BoxedError> { + // do stuff, return other errors + let _buf = std::fs::read_to_string(&path)?; + // do stuff, return other errors Ok(()) } -fn func3() -> Result<(), Box> { - let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; - Ok(()) -} - -derive_str_cherr!(Func2Error); - -fn func2() -> ChainResult<(), Func2Error> { - func3().map_err(mstrerr!(Func2Error, "func2 error: calling func3"))?; - Ok(()) -} - -enum Func1Error { - Func2, - IO(String), -} - -impl ::std::fmt::Display for Func1Error { - fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { - match self { - Func1Error::Func2 => write!(f, "func1 error calling func2"), - Func1Error::IO(filename) => write!(f, "Error reading '{}'", filename), - } - } -} - -impl ::std::fmt::Debug for Func1Error { - fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { - write!(f, "{}", self) - } -} - -fn func1() -> ChainResult<(), Func1Error> { - func2().map_err(|e| cherr!(e, Func1Error::Func2))?; - let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, Func1Error::IO(filename)))?; +fn process_config_file() -> Result<(), BoxedError> { + // do stuff, return other errors + let _buf = read_config_file("foo.txt".into())?; + // do stuff, return other errors Ok(()) } fn main() { - if let Err(e) = func1() { - match e.kind() { - Func1Error::Func2 => eprintln!("Main Error Report: func1 error calling func2"), - Func1Error::IO(filename) => { - eprintln!("Main Error Report: func1 error reading '{}'", filename) - } - } - - if let Some(e) = e.find_chain_cause::() { - eprintln!("\nError reported by Func2Error: {}", e) - } - - if let Some(e) = e.root_cause() { - let ioerror = e.downcast_ref::().unwrap(); - eprintln!("\nThe root cause was: std::io::Error: {:#?}", ioerror); - } - - eprintln!("\nDebug Error:\n{:?}", e); + if let Err(e) = process_config_file() { + eprintln!("Error:\n{:?}", e); } } +``` -~~~ +This gives the output: +```console +Error: +Os { code: 2, kind: NotFound, message: "No such file or directory" } +``` +and you have no idea where it comes from. -## Features -`no-fileline` -: completely turn off storing filename and line +With `chainerror`, you can supply a context and get a nice error backtrace: -`display-cause` -: turn on printing a backtrace of the errors in `Display` +```rust +use chainerror::Context as _; +use std::path::PathBuf; -`no-debug-cause` -: turn off printing a backtrace of the errors in `Debug` +type BoxedError = Box; +fn read_config_file(path: PathBuf) -> Result<(), BoxedError> { + // do stuff, return other errors + let _buf = std::fs::read_to_string(&path).context(format!("Reading file: {:?}", &path))?; + // do stuff, return other errors + Ok(()) +} + +fn process_config_file() -> Result<(), BoxedError> { + // do stuff, return other errors + let _buf = read_config_file("foo.txt".into()).context("read the config file")?; + // do stuff, return other errors + Ok(()) +} + +fn main() { + if let Err(e) = process_config_file() { + eprintln!("Error:\n{:?}", e); + } +} +``` + +with the output: +```console +Error: +examples/simple.rs:14:51: read the config file +Caused by: +examples/simple.rs:7:47: Reading file: "foo.txt" +Caused by: +Os { code: 2, kind: NotFound, message: "No such file or directory" } +``` + +`chainerror` uses `.source()` of `std::error::Error` along with `#[track_caller]` and `Location` to provide a nice debug error backtrace. +It encapsulates all types, which have `Display + Debug` and can store the error cause internally. + +Along with the `Error` struct, `chainerror` comes with some useful helper macros to save a lot of typing. + +`chainerror` has no dependencies! + +Debug information is worth it! + +## Multiple Output Formats + +`chainerror` supports multiple output formats, which can be selected with the different format specifiers: + +* `{}`: Display +```console +func1 error calling func2 +``` + +* `{:#}`: Alternative Display +```console +func1 error calling func2 +Caused by: + func2 error: calling func3 +Caused by: + (passed error) +Caused by: + Error reading 'foo.txt' +Caused by: + entity not found +``` + +* `{:?}`: Debug +```console +examples/example.rs:50:13: func1 error calling func2 +Caused by: +examples/example.rs:25:13: Func2Error(func2 error: calling func3) +Caused by: +examples/example.rs:18:13: (passed error) +Caused by: +examples/example.rs:13:18: Error reading 'foo.txt' +Caused by: +Kind(NotFound) + +``` + +* `{:#?}`: Alternative Debug +```console +Error { + occurrence: Some( + "examples/example.rs:50:13", + ), + kind: func1 error calling func2, + source: Some( + Error { + occurrence: Some( + "examples/example.rs:25:13", + ), + kind: Func2Error(func2 error: calling func3), + source: Some( + Error { + occurrence: Some( + "examples/example.rs:18:13", + ), + kind: (passed error), + source: Some( + Error { + occurrence: Some( + "examples/example.rs:13:18", + ), + kind: "Error reading 'foo.txt'", + source: Some( + Kind( + NotFound, + ), + ), + }, + ), + }, + ), + }, + ), +} +``` + +## Tutorial + +Read the [Tutorial](https://haraldh.github.io/chainerror/tutorial1.html) + +## License + +Licensed under either of + +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or ) +* MIT license ([LICENSE-MIT](LICENSE-MIT) or ) + +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. diff --git a/booksrc/LICENSE-APACHE b/booksrc/LICENSE-APACHE new file mode 120000 index 0000000..965b606 --- /dev/null +++ b/booksrc/LICENSE-APACHE @@ -0,0 +1 @@ +../LICENSE-APACHE \ No newline at end of file diff --git a/booksrc/LICENSE-MIT b/booksrc/LICENSE-MIT new file mode 120000 index 0000000..76219eb --- /dev/null +++ b/booksrc/LICENSE-MIT @@ -0,0 +1 @@ +../LICENSE-MIT \ No newline at end of file diff --git a/booksrc/SUMMARY.md b/booksrc/SUMMARY.md index 91ef467..6bbc3b4 100644 --- a/booksrc/SUMMARY.md +++ b/booksrc/SUMMARY.md @@ -5,7 +5,7 @@ - [Simple String Errors](tutorial1.md) - [Simple Chained String Errors](tutorial2.md) - [Mapping Errors](tutorial3.md) -- [Saving coding chars](tutorial4.md) +- [More Information](tutorial4.md) - [The source() of Errors](tutorial5.md) - [Downcast the Errors](tutorial6.md) - [The root cause of all Errors](tutorial7.md) @@ -17,4 +17,4 @@ - [Writing a library](tutorial13.md) - [Going back to std](tutorial14.md) -[The End](end.md) \ No newline at end of file +[The End](end.md) diff --git a/booksrc/tutorial1.md b/booksrc/tutorial1.md index ae73400..57a502f 100644 --- a/booksrc/tutorial1.md +++ b/booksrc/tutorial1.md @@ -9,7 +9,7 @@ this only prints out the last `Error`. ~~~ -Error: StringError("func1 error") +Error: "func1 error" ~~~ The next chapters of this tutorial show how `chainerror` adds more information diff --git a/booksrc/tutorial10.md b/booksrc/tutorial10.md index e7f2ee4..5547954 100644 --- a/booksrc/tutorial10.md +++ b/booksrc/tutorial10.md @@ -1,20 +1,16 @@ # ErrorKind to the rescue -To cope with different kind of errors, we introduce the kind of an error `Func1ErrorKind` with an enum. +To cope with different kind of errors, we introduce the `kind` of an error `Func1ErrorKind` with an enum. Because we derive `Debug` and implement `Display` our `Func1ErrorKind` enum, this enum can be used as a `std::error::Error`. -Not using `String` errors anymore, the `cherr!()` macro seen in the beginning of -the tutorial has to be used again. - Only returning `Func1ErrorKind` in `func1()` now let us get rid of `Result<(), Box>` and we can use `ChainResult<(), Func1ErrorKind>`. -In `main` we can now directly use the methods of `ChainError` without downcasting the error first. +In `main` we can now directly use the methods of `chainerror::Error` without downcasting the error first. -Also a nice `match` on `ChainError.kind()` is now possible, which returns `&T`, meaning -`&Func1ErrorKind` here. +Also, a nice `match` on `chainerror::Error.kind()` is now possible, which returns `&T`, meaning `&Func1ErrorKind` here. ~~~rust {{#include ../examples/tutorial10.rs}} @@ -22,4 +18,4 @@ Also a nice `match` on `ChainError.kind()` is now possible, which returns `&T # mod chainerror { {{#rustdoc_include ../src/lib.rs:-1}} # } -~~~ \ No newline at end of file +~~~ diff --git a/booksrc/tutorial11.md b/booksrc/tutorial11.md index 0d2c0cc..7d37814 100644 --- a/booksrc/tutorial11.md +++ b/booksrc/tutorial11.md @@ -1,6 +1,6 @@ # Debug for the ErrorKind -One small improvement at the end of the tutorial is to fix the debug output of +One small improvement is to fix the debug output of `Func1ErrorKind`. As you probably noticed, the output doesn't say much of the enum. ~~~ @@ -21,7 +21,7 @@ which gives us a lot more detail. To create your own Errors, you might find [crates](https://crates.io) which create enum `Display+Debug` via derive macros. -Also noteworthy is [custom_error](https://crates.io/crates/custom_error) to define your custom errors, +Also, noteworthy is [custom_error](https://crates.io/crates/custom_error) to define your custom errors, which can then be used with `chainerror`. ~~~rust diff --git a/booksrc/tutorial12.md b/booksrc/tutorial12.md index a8c80e6..037803b 100644 --- a/booksrc/tutorial12.md +++ b/booksrc/tutorial12.md @@ -1,6 +1,6 @@ # Deref for the ErrorKind -Because ChainError implements Deref to &T, we can also match on `*e` instead of `e.kind()` +Because chainerror::Error implements Deref to &T, we can also match on `*e` instead of `e.kind()` or call a function with `&e` ~~~rust {{#include ../examples/tutorial12.rs}} diff --git a/booksrc/tutorial13.md b/booksrc/tutorial13.md index 6d438f4..0ed9db8 100644 --- a/booksrc/tutorial13.md +++ b/booksrc/tutorial13.md @@ -1,6 +1,6 @@ # Writing a library -I would advise to only expose an `mycrate::ErrorKind` and type alias `mycrate::Error` to `ChainError` +I would advise to only expose an `mycrate::ErrorKind` and type alias `mycrate::Error` to `chainerror::Error` so you can tell your library users to use the `.kind()` method as `std::io::Error` does. If you later decide to make your own `Error` implementation, your library users don't diff --git a/booksrc/tutorial2.md b/booksrc/tutorial2.md index e7c5e6d..a330c1a 100644 --- a/booksrc/tutorial2.md +++ b/booksrc/tutorial2.md @@ -1,7 +1,7 @@ # Simple Chained String Errors -With relatively small changes and the help of the `cherr!` macro of the `chainerror` crate -the `String` errors are now chained together. +With relatively small changes and the help of the `context()` method of the `chainerror` crate +the `&str` errors are now chained together. Press the play button in the upper right corner and see the nice debug output. @@ -19,14 +19,13 @@ Press the play button in the upper right corner and see the nice debug output. {{#include ../examples/tutorial2.rs:13:15}} ~~~ -The macro `cherr!(olderror, newerror)` stores `olderror` as the source/cause of `newerror` -along with the filename (`file!()`) and line number (`line!()`) -and returns `newerror`. +The function `context(newerror)` stores `olderror` as the source/cause of `newerror` +along with the `Location` of the `context()` call and returns `Err(newerror)`. -`Err()?` then returns the inner error applying `.into()`, so that we +`?` then returns the inner error applying `.into()`, so that we again have a `Err(Box)` as a result. -The `Debug` implementation of `ChainError` (which is returned by `cherr!()`) +The `Debug` implementation of `chainerror::Error` (which is returned by `context()`) prints the `Debug` of `T` prefixed with the stored filename and line number. -`ChainError` in our case is `ChainError`. +`chainerror::Error` in our case is `chainerror::Error<&str>`. diff --git a/booksrc/tutorial3.md b/booksrc/tutorial3.md index cc832a9..f6c26ac 100644 --- a/booksrc/tutorial3.md +++ b/booksrc/tutorial3.md @@ -1,6 +1,6 @@ # Mapping Errors -Now let's get more rust idiomatic by using `.map_err()`. +Now let's get more rust idiomatic by using `.context()` directly on the previous `Result`. ~~~rust {{#include ../examples/tutorial3.rs}} @@ -14,16 +14,16 @@ If you compare the output to the previous example, you will see, that: ~~~ -Error: src/main.rs:19: "func1 error" +Error: examples/tutorial2.rs:20:16: func1 error ~~~ changed to just: ~~~ -src/main.rs:16: "func1 error" +examples/tutorial3.rs:17:13: func1 error ~~~ This is, because we caught the error of `func1()` in `main()` and print it out ourselves. We can now control, whether to output in `Debug` or `Display` mode. -Maybe depending on `--debug` as a CLI argument. \ No newline at end of file +Maybe depending on `--debug` as a CLI argument. diff --git a/booksrc/tutorial4.md b/booksrc/tutorial4.md index 68cc16d..f717706 100644 --- a/booksrc/tutorial4.md +++ b/booksrc/tutorial4.md @@ -1,12 +1,7 @@ -# Saving coding chars +# More information -Because decorating an error with more information should not -let you jump through hoops, `chainerror` has a quick macro for that. - -`mstrerror!()` fits right into `.map_err()` letting you quickly add -more debug strings. - -`mstrerror!()` even understands `format!()` syntax like `println!()`. +To give more context to the error, you want to use `format!` +to extend the information in the context string. ~~~rust {{#include ../examples/tutorial4.rs}} @@ -14,4 +9,4 @@ more debug strings. # mod chainerror { {{#rustdoc_include ../src/lib.rs:-1}} # } -~~~ \ No newline at end of file +~~~ diff --git a/booksrc/tutorial5.md b/booksrc/tutorial5.md index 05db784..57932fa 100644 --- a/booksrc/tutorial5.md +++ b/booksrc/tutorial5.md @@ -14,5 +14,4 @@ Sometimes you want to inspect the `source()` of an `Error`. Note, that because we changed the output of the error in `main()` from `Debug` to `Display`, we don't see the error backtrace with filename and line number. -To enable the `Display` backtrace, you have to enable the feature `display-cause` for `chainerror`. - \ No newline at end of file +To use the `Display` backtrace, you have to use the alternative display format output `{:#}`. diff --git a/booksrc/tutorial7.md b/booksrc/tutorial7.md index ccb6ff6..90665f7 100644 --- a/booksrc/tutorial7.md +++ b/booksrc/tutorial7.md @@ -4,15 +4,15 @@ ~~~rust,ignore fn is_chain(&self) -> bool -fn downcast_chain_ref(&self) -> Option<&ChainError> -fn downcast_chain_mut(&mut self) -> Option<&mut ChainError> +fn downcast_chain_ref(&self) -> Option<&chainerror::Error> +fn downcast_chain_mut(&mut self) -> Option<&mut chainerror::Error> fn root_cause(&self) -> Option<&(dyn Error + 'static)> fn find_cause(&self) -> Option<&U> -fn find_chain_cause(&self) -> Option<&ChainError> +fn find_chain_cause(&self) -> Option<&chainerror::Error> fn kind<'a>(&'a self) -> &'a T ~~~ -Using `downcast_chain_ref::()` gives a `ChainError`, which can be used +Using `downcast_chain_ref::()` gives a `chainerror::Error`, which can be used to call `.find_cause::()`. ~~~rust,ignore diff --git a/booksrc/tutorial8.md b/booksrc/tutorial8.md index 8060788..17070fe 100644 --- a/booksrc/tutorial8.md +++ b/booksrc/tutorial8.md @@ -1,14 +1,14 @@ # Finding an Error cause -To distinguish the errors occuring in various places, we can define named string errors with the +To distinguish the errors occurring in various places, we can define named string errors with the "new type" pattern. ~~~rust,ignore -derive_str_cherr!(Func2Error); -derive_str_cherr!(Func1Error); +chainerror::str_context!(Func2Error); +chainerror::str_context!(Func1Error); ~~~ -Instead of `ChainError` we now have `struct Func1Error(String)` and `ChainError`. +Instead of `chainerror::Error` we now have `struct Func1Error(String)` and `chainerror::Error`. In the `main` function you can see, how we can match the different errors. @@ -18,9 +18,9 @@ Also see: ~~~ as a shortcut to ~~~rust,ignore - if let Some(f2err) = f1err.find_cause::>() { + if let Some(f2err) = f1err.find_cause::>() { ~~~ -hiding the `ChainError` implementation detail. +hiding the `chainerror::Error` implementation detail. ~~~rust {{#include ../examples/tutorial8.rs}} @@ -28,4 +28,4 @@ hiding the `ChainError` implementation detail. # mod chainerror { {{#rustdoc_include ../src/lib.rs:-1}} # } -~~~ \ No newline at end of file +~~~ diff --git a/examples/example.rs b/examples/example.rs index 99f965e..82c073f 100644 --- a/examples/example.rs +++ b/examples/example.rs @@ -1,24 +1,28 @@ +use chainerror::Context as _; use std::error::Error; +use std::fmt; use std::io; -use std::result::Result; - -use chainerror::*; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -fn func3() -> Result<(), Box> { +fn func4() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; + do_some_io().context(format!("Error reading '{}'", filename))?; Ok(()) } -derive_str_cherr!(Func2Error); +fn func3() -> Result<(), Box> { + func4().annotate()?; + Ok(()) +} -fn func2() -> ChainResult<(), Func2Error> { - func3().map_err(mstrerr!(Func2Error, "func2 error: calling func3"))?; +chainerror::str_context!(Func2Error); + +fn func2() -> chainerror::Result<(), Func2Error> { + func3().context(Func2Error::new("func2 error: calling func3"))?; Ok(()) } @@ -27,8 +31,8 @@ enum Func1Error { IO(String), } -impl ::std::fmt::Display for Func1Error { - fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { +impl fmt::Display for Func1Error { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { Func1Error::Func2 => write!(f, "func1 error calling func2"), Func1Error::IO(filename) => write!(f, "Error reading '{}'", filename), @@ -36,21 +40,29 @@ impl ::std::fmt::Display for Func1Error { } } -impl ::std::fmt::Debug for Func1Error { - fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { +impl fmt::Debug for Func1Error { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self) } } -fn func1() -> ChainResult<(), Func1Error> { - func2().map_err(|e| cherr!(e, Func1Error::Func2))?; +fn func1() -> chainerror::Result<(), Func1Error> { + func2().context(Func1Error::Func2)?; let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, Func1Error::IO(filename)))?; + do_some_io().context(Func1Error::IO(filename))?; Ok(()) } fn main() { if let Err(e) = func1() { + eprintln!("\nDisplay Error {{}}:\n{}", e); + + eprintln!("\nAlternative Display Error {{:#}}:\n{:#}", e); + + eprintln!("\nDebug Error {{:?}}:\n{:?}", e); + + eprintln!("\nAlternative Debug Error {{:#?}}:\n{:#?}\n", e); + match e.kind() { Func1Error::Func2 => eprintln!("Main Error Report: func1 error calling func2"), Func1Error::IO(filename) => { @@ -66,7 +78,5 @@ fn main() { let ioerror = e.downcast_ref::().unwrap(); eprintln!("\nThe root cause was: std::io::Error: {:#?}", ioerror); } - - eprintln!("\nDebug Error:\n{:?}", e); } } diff --git a/examples/tutorial1.rs b/examples/tutorial1.rs index 4ac1eb3..08ca3e8 100644 --- a/examples/tutorial1.rs +++ b/examples/tutorial1.rs @@ -1,6 +1,8 @@ +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; diff --git a/examples/tutorial10.rs b/examples/tutorial10.rs index cf13909..3e0af4a 100644 --- a/examples/tutorial10.rs +++ b/examples/tutorial10.rs @@ -1,18 +1,18 @@ -use chainerror::*; +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -derive_str_cherr!(Func2Error); +chainerror::str_context!(Func2Error); fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } @@ -32,10 +32,10 @@ impl ::std::fmt::Display for Func1ErrorKind { } impl ::std::error::Error for Func1ErrorKind {} -fn func1() -> ChainResult<(), Func1ErrorKind> { - func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?; +fn func1() -> chainerror::Result<(), Func1ErrorKind> { + func2().context(Func1ErrorKind::Func2)?; let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?; + do_some_io().context(Func1ErrorKind::IO(filename))?; Ok(()) } @@ -53,6 +53,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial11.rs b/examples/tutorial11.rs index 5f85c23..abbca94 100644 --- a/examples/tutorial11.rs +++ b/examples/tutorial11.rs @@ -1,18 +1,18 @@ -use chainerror::*; +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -derive_str_cherr!(Func2Error); +chainerror::str_context!(Func2Error); fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } @@ -38,10 +38,10 @@ impl ::std::fmt::Debug for Func1ErrorKind { impl ::std::error::Error for Func1ErrorKind {} -fn func1() -> ChainResult<(), Func1ErrorKind> { - func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?; +fn func1() -> chainerror::Result<(), Func1ErrorKind> { + func2().context(Func1ErrorKind::Func2)?; let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?; + do_some_io().context(Func1ErrorKind::IO(filename))?; Ok(()) } @@ -59,6 +59,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial12.rs b/examples/tutorial12.rs index f5e38de..caa8fca 100644 --- a/examples/tutorial12.rs +++ b/examples/tutorial12.rs @@ -1,18 +1,18 @@ -use chainerror::*; +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -derive_str_cherr!(Func2Error); +chainerror::str_context!(Func2Error); fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } @@ -38,10 +38,10 @@ impl ::std::fmt::Debug for Func1ErrorKind { impl ::std::error::Error for Func1ErrorKind {} -fn func1() -> ChainResult<(), Func1ErrorKind> { - func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?; +fn func1() -> chainerror::Result<(), Func1ErrorKind> { + func2().context(Func1ErrorKind::Func2)?; let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?; + do_some_io().context(Func1ErrorKind::IO(filename))?; Ok(()) } @@ -70,6 +70,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial13.rs b/examples/tutorial13.rs index c345157..0d50d68 100644 --- a/examples/tutorial13.rs +++ b/examples/tutorial13.rs @@ -1,5 +1,9 @@ +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] + pub mod mycrate { - use chainerror::*; + use chainerror::Context as _; + use std::io; fn do_some_io() -> std::result::Result<(), Box> { @@ -7,11 +11,11 @@ pub mod mycrate { Ok(()) } - derive_str_cherr!(Func2Error); + chainerror::str_context!(Func2Error); fn func2() -> std::result::Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } @@ -21,7 +25,7 @@ pub mod mycrate { IO(String), } - derive_err_kind!(Error, ErrorKind); + chainerror::err_kind!(Error, ErrorKind); pub type Result = std::result::Result; @@ -35,9 +39,9 @@ pub mod mycrate { } pub fn func1() -> Result<()> { - func2().map_err(|e| cherr!(e, ErrorKind::Func2))?; + func2().context(ErrorKind::Func2)?; let filename = String::from("bar.txt"); - do_some_io().map_err(|e| cherr!(e, ErrorKind::IO(filename)))?; + do_some_io().context(ErrorKind::IO(filename))?; Ok(()) } } @@ -72,6 +76,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial14.rs b/examples/tutorial14.rs index 84c3491..5ec216e 100644 --- a/examples/tutorial14.rs +++ b/examples/tutorial14.rs @@ -1,7 +1,10 @@ +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] + pub mod mycrate { use std::error::Error as StdError; - use func2mod::{do_some_io, func2}; + use self::func2mod::{do_some_io, func2}; pub mod func2mod { use std::error::Error as StdError; @@ -27,7 +30,7 @@ pub mod mycrate { } } - macro_rules! mcherr { + macro_rules! mcontext { ( $k:expr ) => {{ |e| { Error( @@ -92,7 +95,7 @@ pub mod mycrate { pub fn func2() -> std::result::Result<(), Error> { let filename = "foo.txt"; - do_some_io().map_err(mcherr!(ErrorKind::IO(format!( + do_some_io().map_err(mcontext!(ErrorKind::IO(format!( "Error reading '{}'", filename ))))?; @@ -115,7 +118,7 @@ pub mod mycrate { } } - macro_rules! mcherr { + macro_rules! mcontext { ( $k:expr ) => {{ |e| { Error( @@ -175,9 +178,9 @@ pub mod mycrate { pub type Result = std::result::Result; pub fn func1() -> Result<()> { - func2().map_err(mcherr!(ErrorKind::Func2))?; + func2().map_err(mcontext!(ErrorKind::Func2))?; let filename = String::from("bar.txt"); - do_some_io().map_err(mcherr!(ErrorKind::IO(filename)))?; + do_some_io().map_err(mcontext!(ErrorKind::IO(filename)))?; Ok(()) } } @@ -212,6 +215,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial15.rs b/examples/tutorial15.rs index 581840c..42355b3 100644 --- a/examples/tutorial15.rs +++ b/examples/tutorial15.rs @@ -1,19 +1,21 @@ -pub mod mycrate { - use std::io; +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] - use chainerror::*; +pub mod mycrate { + use chainerror::{Context as _, ErrorDown as _}; + + use std::io; fn do_some_io(_f: &str) -> std::result::Result<(), io::Error> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } - derive_str_cherr!(Func2Error); + chainerror::str_context!(Func2Error); fn func2() -> std::result::Result<(), Box> { let filename = "foo.txt"; - do_some_io(filename) - .map_err(|e| cherr!(e, Func2Error(format!("Error reading '{}'", filename))))?; + do_some_io(filename).context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } @@ -25,7 +27,7 @@ pub mod mycrate { Unknown, } - derive_err_kind!(Error, ErrorKind); + chainerror::err_kind!(Error, ErrorKind); pub type Result = std::result::Result; impl std::fmt::Display for ErrorKind { @@ -82,21 +84,19 @@ pub mod mycrate { } pub fn func1() -> Result<()> { - func2().map_err(|e| cherr!(e, ErrorKind::from(&e)))?; + func2().map_err(|e| ErrorKind::from(&e))?; let filename = "bar.txt"; - do_some_io(filename) - .map_err(|e| cherr!(e, ErrorKind::from_io_error(&e, filename.into())))?; - do_some_io(filename).map_err(|e| cherr!(e, ErrorKind::IO(filename.into())))?; - do_some_io(filename).map_err(|e| cherr!(e, ErrorKind::from(&e)))?; - do_some_io(filename).map_err(minto_cherr!(ErrorKind))?; + do_some_io(filename).map_context(|e| ErrorKind::from_io_error(e, filename.into()))?; + do_some_io(filename).map_context(|_| ErrorKind::IO(filename.into()))?; + do_some_io(filename).map_context(|e| ErrorKind::from(e))?; Ok(()) } pub fn super_func1() -> Result<()> { - func1().map_err(minto_cherr!(ErrorKind))?; + func1().map_context(|e| ErrorKind::from(e))?; Ok(()) } } @@ -133,6 +133,8 @@ fn main() -> Result<(), Box> { } eprintln!("\nDebug Error:\n{:?}", e); + + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial2.rs b/examples/tutorial2.rs index b13f0cc..96742ad 100644 --- a/examples/tutorial2.rs +++ b/examples/tutorial2.rs @@ -1,8 +1,7 @@ -use chainerror::*; +use chainerror::Context as _; use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -11,14 +10,14 @@ fn do_some_io() -> Result<(), Box> { fn func2() -> Result<(), Box> { if let Err(e) = do_some_io() { - Err(cherr!(e, "func2 error"))?; + Err(e).context("func2 error")?; } Ok(()) } fn func1() -> Result<(), Box> { if let Err(e) = func2() { - Err(cherr!(e, "func1 error"))?; + Err(e).context("func1 error")?; } Ok(()) } diff --git a/examples/tutorial3.rs b/examples/tutorial3.rs index 6da067c..62a44eb 100644 --- a/examples/tutorial3.rs +++ b/examples/tutorial3.rs @@ -1,8 +1,7 @@ -use chainerror::*; +use chainerror::Context as _; use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -10,18 +9,19 @@ fn do_some_io() -> Result<(), Box> { } fn func2() -> Result<(), Box> { - do_some_io().map_err(|e| cherr!(e, "func2 error"))?; + do_some_io().context("func2 error")?; Ok(()) } fn func1() -> Result<(), Box> { - func2().map_err(|e| cherr!(e, "func1 error"))?; + func2().context("func1 error")?; Ok(()) } fn main() -> Result<(), Box> { if let Err(e) = func1() { eprintln!("{:?}", e); + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial4.rs b/examples/tutorial4.rs index e1225c0..3dea51c 100644 --- a/examples/tutorial4.rs +++ b/examples/tutorial4.rs @@ -1,7 +1,7 @@ -use chainerror::*; +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -10,18 +10,19 @@ fn do_some_io() -> Result<(), Box> { fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; + do_some_io().context(format!("Error reading '{}'", filename))?; Ok(()) } fn func1() -> Result<(), Box> { - func2().map_err(mstrerr!("func1 error"))?; + func2().context("func1 error")?; Ok(()) } fn main() -> Result<(), Box> { if let Err(e) = func1() { eprintln!("{:?}", e); + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial5.rs b/examples/tutorial5.rs index cb80569..d9fe708 100644 --- a/examples/tutorial5.rs +++ b/examples/tutorial5.rs @@ -1,7 +1,7 @@ -use chainerror::*; +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -10,7 +10,7 @@ fn do_some_io() -> Result<(), Box> { fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; + do_some_io().context(format!("Error reading '{}'", filename))?; Ok(()) } @@ -18,7 +18,7 @@ fn func1() -> Result<(), Box> { if let Err(e) = func2() { if let Some(s) = e.source() { eprintln!("func2 failed because of '{}'", s); - Err(e).map_err(mstrerr!("func1 error"))?; + Err(e).context("func1 error")?; } } Ok(()) @@ -27,6 +27,7 @@ fn func1() -> Result<(), Box> { fn main() -> Result<(), Box> { if let Err(e) = func1() { eprintln!("{}", e); + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial6.rs b/examples/tutorial6.rs index 996540c..5d81310 100644 --- a/examples/tutorial6.rs +++ b/examples/tutorial6.rs @@ -1,7 +1,10 @@ -use chainerror::*; +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] + +use chainerror::Context as _; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -10,12 +13,12 @@ fn do_some_io() -> Result<(), Box> { fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; + do_some_io().context(format!("Error reading '{}'", filename))?; Ok(()) } fn func1() -> Result<(), Box> { - func2().map_err(mstrerr!("func1 error"))?; + func2().context("func1 error")?; Ok(()) } @@ -35,6 +38,7 @@ fn main() -> Result<(), Box> { } s = c; } + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial7.rs b/examples/tutorial7.rs index b36fa8b..214484c 100644 --- a/examples/tutorial7.rs +++ b/examples/tutorial7.rs @@ -1,7 +1,10 @@ -use chainerror::*; +#![allow(clippy::single_match)] +#![allow(clippy::redundant_pattern_matching)] + +use chainerror::{Context as _, ErrorDown as _}; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; @@ -10,12 +13,12 @@ fn do_some_io() -> Result<(), Box> { fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; + do_some_io().context(format!("Error reading '{}'", filename))?; Ok(()) } fn func1() -> Result<(), Box> { - func2().map_err(mstrerr!("func1 error"))?; + func2().context("func1 error")?; Ok(()) } @@ -36,6 +39,7 @@ fn main() -> Result<(), Box> { eprintln!("The root cause was: std::io::Error: {:#?}", ioerror); } } + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial8.rs b/examples/tutorial8.rs index 1644a32..e32a449 100644 --- a/examples/tutorial8.rs +++ b/examples/tutorial8.rs @@ -1,25 +1,25 @@ -use chainerror::*; +use chainerror::{Context as _, ErrorDown as _}; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -derive_str_cherr!(Func2Error); +chainerror::str_context!(Func2Error); fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } -derive_str_cherr!(Func1Error); +chainerror::str_context!(Func1Error); fn func1() -> Result<(), Box> { - func2().map_err(mstrerr!(Func1Error, "func1 error"))?; + func2().context(Func1Error::new("func1 error"))?; Ok(()) } @@ -28,7 +28,7 @@ fn main() -> Result<(), Box> { if let Some(f1err) = e.downcast_chain_ref::() { eprintln!("Func1Error: {}", f1err); - if let Some(f2err) = f1err.find_cause::>() { + if let Some(f2err) = f1err.find_cause::>() { eprintln!("Func2Error: {}", f2err); } @@ -36,6 +36,7 @@ fn main() -> Result<(), Box> { eprintln!("Debug Func2Error:\n{:?}", f2err); } } + std::process::exit(1); } Ok(()) } diff --git a/examples/tutorial9.rs b/examples/tutorial9.rs index 99b0f23..bbbe810 100644 --- a/examples/tutorial9.rs +++ b/examples/tutorial9.rs @@ -1,40 +1,41 @@ -use chainerror::*; +use chainerror::{Context as _, ErrorDown}; + use std::error::Error; use std::io; -use std::result::Result; fn do_some_io() -> Result<(), Box> { Err(io::Error::from(io::ErrorKind::NotFound))?; Ok(()) } -derive_str_cherr!(Func2Error); +chainerror::str_context!(Func2Error); fn func2() -> Result<(), Box> { let filename = "foo.txt"; - do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; Ok(()) } -derive_str_cherr!(Func1ErrorFunc2); -derive_str_cherr!(Func1ErrorIO); +chainerror::str_context!(Func1ErrorFunc2); +chainerror::str_context!(Func1ErrorIO); fn func1() -> Result<(), Box> { - func2().map_err(mstrerr!(Func1ErrorFunc2, "func1 error calling func2"))?; + func2().context(Func1ErrorFunc2::new("func1 error calling func2"))?; let filename = "bar.txt"; - do_some_io().map_err(mstrerr!(Func1ErrorIO, "Error reading '{}'", filename))?; + do_some_io().context(Func1ErrorIO(format!("Error reading '{}'", filename)))?; Ok(()) } fn main() -> Result<(), Box> { if let Err(e) = func1() { - if let Some(s) = e.downcast_ref::>() { + if let Some(s) = e.downcast_ref::>() { eprintln!("Func1ErrorIO:\n{:?}", s); } if let Some(s) = e.downcast_chain_ref::() { eprintln!("Func1ErrorFunc2:\n{:?}", s); } + std::process::exit(1); } Ok(()) } diff --git a/src/lib.rs b/src/lib.rs index d68a1b6..623523d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,218 +1,30 @@ -//! `chainerror` provides an error backtrace without doing a real backtrace, so even after you `strip` your -//! binaries, you still have the error backtrace. -//! -//! `chainerror` has no dependencies! -//! -//! `chainerror` uses `.source()` of `std::error::Error` along with `line()!` and `file()!` to provide a nice debug error backtrace. -//! It encapsulates all types, which have `Display + Debug` and can store the error cause internally. -//! -//! Along with the `ChainError` struct, `chainerror` comes with some useful helper macros to save a lot of typing. -//! -//! ## Features -//! -//! `no-fileline` -//! : completely turn off storing filename and line -//! -//! `display-cause` -//! : turn on printing a backtrace of the errors in `Display` -//! -//! `no-debug-cause` -//! : turn off printing a backtrace of the errors in `Debug` -//! -//! -//! # Tutorial -//! -//! Read the [Tutorial](https://haraldh.github.io/chainerror/tutorial1.html) -//! -//! # Examples -//! -//! ```rust -//! use chainerror::*; -//! use std::error::Error; -//! use std::io; -//! use std::result::Result; -//! -//! fn do_some_io() -> Result<(), Box> { -//! Err(io::Error::from(io::ErrorKind::NotFound))?; -//! Ok(()) -//! } -//! -//! fn func2() -> Result<(), Box> { -//! let filename = "foo.txt"; -//! do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; -//! Ok(()) -//! } -//! -//! fn func1() -> Result<(), Box> { -//! func2().map_err(mstrerr!("func1 error"))?; -//! Ok(()) -//! } -//! -//! fn main() { -//! if let Err(e) = func1() { -//! #[cfg(not(windows))] -//! assert_eq!( -//! format!("\n{:?}\n", e), r#" -//! src/lib.rs:20: func1 error -//! Caused by: -//! src/lib.rs:15: Error reading 'foo.txt' -//! Caused by: -//! Kind(NotFound) -//! "# -//! ); -//! } -//! # else { -//! # unreachable!(); -//! # } -//! } -//! ``` -//! -//! -//! ```rust -//! use chainerror::*; -//! use std::error::Error; -//! use std::io; -//! use std::result::Result; -//! -//! fn do_some_io() -> Result<(), Box> { -//! Err(io::Error::from(io::ErrorKind::NotFound))?; -//! Ok(()) -//! } -//! -//! fn func3() -> Result<(), Box> { -//! let filename = "foo.txt"; -//! do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; -//! Ok(()) -//! } -//! -//! derive_str_cherr!(Func2Error); -//! -//! fn func2() -> ChainResult<(), Func2Error> { -//! func3().map_err(mstrerr!(Func2Error, "func2 error: calling func3"))?; -//! Ok(()) -//! } -//! -//! enum Func1Error { -//! Func2, -//! IO(String), -//! } -//! -//! impl ::std::fmt::Display for Func1Error { -//! fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { -//! match self { -//! Func1Error::Func2 => write!(f, "func1 error calling func2"), -//! Func1Error::IO(filename) => write!(f, "Error reading '{}'", filename), -//! } -//! } -//! } -//! -//! impl ::std::fmt::Debug for Func1Error { -//! fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { -//! write!(f, "{}", self) -//! } -//! } -//! -//! fn func1() -> ChainResult<(), Func1Error> { -//! func2().map_err(|e| cherr!(e, Func1Error::Func2))?; -//! let filename = String::from("bar.txt"); -//! do_some_io().map_err(|e| cherr!(e, Func1Error::IO(filename)))?; -//! Ok(()) -//! } -//! -//! fn main() { -//! if let Err(e) = func1() { -//! assert!( -//! match e.kind() { -//! Func1Error::Func2 => { -//! eprintln!("Main Error Report: func1 error calling func2"); -//! true -//! } -//! Func1Error::IO(filename) => { -//! eprintln!("Main Error Report: func1 error reading '{}'", filename); -//! false -//! } -//! } -//! ); -//! -//! assert!(e.find_chain_cause::().is_some()); -//! -//! if let Some(e) = e.find_chain_cause::() { -//! eprintln!("\nError reported by Func2Error: {}", e) -//! } -//! -//! -//! assert!(e.root_cause().is_some()); -//! -//! if let Some(e) = e.root_cause() { -//! let io_error = e.downcast_ref::().unwrap(); -//! eprintln!("\nThe root cause was: std::io::Error: {:#?}", io_error); -//! } -//! -//! #[cfg(not(windows))] -//! assert_eq!( -//! format!("\n{:?}\n", e), r#" -//! src/lib.rs:47: func1 error calling func2 -//! Caused by: -//! src/lib.rs:22: Func2Error(func2 error: calling func3) -//! Caused by: -//! src/lib.rs:15: Error reading 'foo.txt' -//! Caused by: -//! Kind(NotFound) -//! "# -//! ); -//! } -//! # else { -//! # unreachable!(); -//! # } -//! } -//! ``` - -#![deny( - warnings, - absolute_paths_not_starting_with_crate, - deprecated_in_future, - keyword_idents, - macro_use_extern_crate, - missing_debug_implementations, - trivial_numeric_casts, - unused_extern_crates, - unused_import_braces, - unused_qualifications, - unused_results, - unused_labels, - unused_lifetimes, - unstable_features, - unreachable_pub, - future_incompatible, - missing_copy_implementations, - missing_doc_code_examples, - rust_2018_idioms, - rust_2018_compatibility -)] +#![doc = include_str!("../README.md")] +#![deny(clippy::all)] +#![allow(clippy::needless_doctest_main)] +#![deny(missing_docs)] use std::any::TypeId; -use std::error::Error; -use std::fmt::{Debug, Display, Formatter, Result}; +use std::error::Error as StdError; +use std::fmt::{Debug, Display, Formatter}; +use std::panic::Location; /// chains an inner error kind `T` with a causing error -pub struct ChainError { - #[cfg(not(feature = "no-fileline"))] - occurrence: Option<&'static str>, +pub struct Error { + occurrence: Option, kind: T, - error_cause: Option>, + error_cause: Option>, } /// convenience type alias -pub type ChainResult = std::result::Result>; +pub type Result = std::result::Result>; -impl ChainError { - #[cfg(not(feature = "no-fileline"))] - /// Use the `cherr!()` or `mstrerr!()` macro instead of calling this directly +impl Error { + /// Use the `context()` or `map_context()` Result methods instead of calling this directly #[inline] pub fn new( kind: T, - error_cause: Option>, - occurrence: Option<&'static str>, + error_cause: Option>, + occurrence: Option, ) -> Self { Self { occurrence, @@ -221,19 +33,8 @@ impl ChainError { } } - #[cfg(feature = "no-fileline")] - /// Use the `cherr!()` or `mstrerr!()` macro instead of calling this directly - #[inline] - pub fn new( - kind: T, - error_cause: Option>, - _occurrence: Option<&'static str>, - ) -> Self { - Self { kind, error_cause } - } - /// return the root cause of the error chain, if any exists - pub fn root_cause(&self) -> Option<&(dyn Error + 'static)> { + pub fn root_cause(&self) -> Option<&(dyn StdError + 'static)> { self.iter().last() } @@ -242,7 +43,8 @@ impl ChainError { /// # Examples /// /// ```rust - /// use chainerror::*; + /// use chainerror::Context as _; + /// use chainerror::ErrorDown as _; /// use std::error::Error; /// use std::io; /// @@ -251,103 +53,100 @@ impl ChainError { /// Ok(()) /// } /// - /// derive_str_cherr!(Func2Error); + /// chainerror::str_context!(Func2Error); /// /// fn func2() -> Result<(), Box> { /// let filename = "foo.txt"; - /// do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + /// do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; /// Ok(()) /// } /// - /// derive_str_cherr!(Func1Error); + /// chainerror::str_context!(Func1Error); /// /// fn func1() -> Result<(), Box> { - /// func2().map_err(mstrerr!(Func1Error, "func1 error"))?; + /// func2().context(Func1Error::new("func1 error"))?; /// Ok(()) /// } /// - /// fn main() { - /// if let Err(e) = func1() { - /// if let Some(f1err) = e.downcast_chain_ref::() { + /// if let Err(e) = func1() { + /// if let Some(f1err) = e.downcast_chain_ref::() { + /// assert!(f1err.find_cause::().is_some()); /// - /// assert!(f1err.find_cause::().is_some()); - /// - /// assert!(f1err.find_chain_cause::().is_some()); - /// } + /// assert!(f1err.find_chain_cause::().is_some()); + /// } /// # else { /// # panic!(); /// # } - /// } + /// } /// # else { /// # unreachable!(); /// # } - /// } /// ``` #[inline] - pub fn find_cause(&self) -> Option<&U> { - self.iter().filter_map(Error::downcast_ref::).next() - } - - /// Find the first error cause of type `ChainError`, if any exists - /// - /// Same as `find_cause`, but hides the `ChainError` implementation internals - /// - /// # Examples - /// - /// ```rust - /// # use chainerror::*; - /// # derive_str_cherr!(FooError); - /// # let err = ChainError::new(String::new(), None, None); - /// // Instead of writing - /// err.find_cause::>(); - /// - /// // leave out the ChainError implementation detail - /// err.find_chain_cause::(); - /// ``` - #[inline] - pub fn find_chain_cause(&self) -> Option<&ChainError> { + pub fn find_cause(&self) -> Option<&U> { self.iter() - .filter_map(Error::downcast_ref::>) + .filter_map(::downcast_ref::) .next() } - /// Find the first error cause of type `ChainError` or `U`, if any exists and return `U` + /// Find the first error cause of type [`Error`](Error), if any exists /// - /// Same as `find_cause` and `find_chain_cause`, but hides the `ChainError` implementation internals + /// Same as `find_cause`, but hides the [`Error`](Error) implementation internals /// /// # Examples /// /// ```rust - /// # use chainerror::*; - /// # derive_str_cherr!(FooErrorKind); - /// # let err = ChainError::new(String::new(), None, None); + /// # chainerror::str_context!(FooError); + /// # let err = chainerror::Error::new(String::new(), None, None); /// // Instead of writing - /// err.find_cause::>(); + /// err.find_cause::>(); + /// + /// // leave out the chainerror::Error implementation detail + /// err.find_chain_cause::(); + /// ``` + #[inline] + pub fn find_chain_cause(&self) -> Option<&Error> { + self.iter() + .filter_map(::downcast_ref::>) + .next() + } + + /// Find the first error cause of type [`Error`](Error) or `U`, if any exists and return `U` + /// + /// Same as `find_cause` and `find_chain_cause`, but hides the [`Error`](Error) implementation internals + /// + /// # Examples + /// + /// ```rust + /// # chainerror::str_context!(FooErrorKind); + /// # let err = chainerror::Error::new(String::new(), None, None); + /// // Instead of writing + /// err.find_cause::>(); /// // and/or /// err.find_chain_cause::(); /// // and/or /// err.find_cause::(); /// - /// // leave out the ChainError implementation detail + /// // leave out the chainerror::Error implementation detail /// err.find_kind_or_cause::(); /// ``` #[inline] - pub fn find_kind_or_cause(&self) -> Option<&U> { + pub fn find_kind_or_cause(&self) -> Option<&U> { self.iter() .filter_map(|e| { - e.downcast_ref::>() + e.downcast_ref::>() .map(|e| e.kind()) .or_else(|| e.downcast_ref::()) }) .next() } - /// Return a reference to T of `ChainError` + /// Return a reference to T of [`Error`](Error) /// /// # Examples /// /// ```rust - /// use chainerror::*; + /// use chainerror::Context as _; /// use std::error::Error; /// use std::io; /// @@ -356,11 +155,11 @@ impl ChainError { /// Ok(()) /// } /// - /// derive_str_cherr!(Func2Error); + /// chainerror::str_context!(Func2Error); /// /// fn func2() -> Result<(), Box> { /// let filename = "foo.txt"; - /// do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; + /// do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; /// Ok(()) /// } /// @@ -380,23 +179,21 @@ impl ChainError { /// # } /// # } /// - /// fn func1() -> ChainResult<(), Func1ErrorKind> { - /// func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?; - /// do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO("bar.txt".into())))?; + /// fn func1() -> chainerror::Result<(), Func1ErrorKind> { + /// func2().context(Func1ErrorKind::Func2)?; + /// do_some_io().context(Func1ErrorKind::IO("bar.txt".into()))?; /// Ok(()) /// } /// - /// fn main() { - /// if let Err(e) = func1() { - /// match e.kind() { - /// Func1ErrorKind::Func2 => {} - /// Func1ErrorKind::IO(filename) => panic!(), - /// } + /// if let Err(e) = func1() { + /// match e.kind() { + /// Func1ErrorKind::Func2 => {} + /// Func1ErrorKind::IO(filename) => panic!(), /// } + /// } /// # else { /// # unreachable!(); /// # } - /// } /// ``` #[inline] pub fn kind(&self) -> &T { @@ -406,32 +203,110 @@ impl ChainError { /// Returns an Iterator over all error causes/sources /// /// # Example - /// - /// #[inline] - pub fn iter(&self) -> impl Iterator { + pub fn iter(&self) -> impl Iterator { ErrorIter { current: Some(self), } } } -struct ErrorIter<'a> { - current: Option<&'a (dyn Error + 'static)>, +/// Convenience methods for `Result<>` to turn the error into a decorated [`Error`](Error) +pub trait Context>> { + /// Decorate the error with a `kind` of type `T` and the source `Location` + fn context(self, kind: T) -> std::result::Result>; + + /// Decorate the error just with the source `Location` + fn annotate(self) -> std::result::Result>; + + /// Decorate the `error` with a `kind` of type `T` produced with a `FnOnce(&error)` and the source `Location` + fn map_context T>( + self, + op: F, + ) -> std::result::Result>; +} + +/// Convenience type to just decorate the error with the source `Location` +pub struct AnnotatedError(()); + +impl Display for AnnotatedError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "(passed error)") + } +} + +impl Debug for AnnotatedError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + write!(f, "(passed error)") + } +} + +impl>> Context + for std::result::Result +{ + #[track_caller] + #[inline] + fn context(self, kind: T) -> std::result::Result> { + match self { + Ok(t) => Ok(t), + Err(error_cause) => Err(Error::new( + kind, + Some(error_cause.into()), + Some(Location::caller().to_string()), + )), + } + } + + #[track_caller] + #[inline] + fn annotate(self) -> std::result::Result> { + match self { + Ok(t) => Ok(t), + Err(error_cause) => Err(Error::new( + AnnotatedError(()), + Some(error_cause.into()), + Some(Location::caller().to_string()), + )), + } + } + + #[track_caller] + #[inline] + fn map_context T>( + self, + op: F, + ) -> std::result::Result> { + match self { + Ok(t) => Ok(t), + Err(error_cause) => { + let kind = op(&error_cause); + Err(Error::new( + kind, + Some(error_cause.into()), + Some(Location::caller().to_string()), + )) + } + } + } +} + +/// An iterator over all error causes/sources +pub struct ErrorIter<'a> { + current: Option<&'a (dyn StdError + 'static)>, } impl<'a> Iterator for ErrorIter<'a> { - type Item = &'a (dyn Error + 'static); + type Item = &'a (dyn StdError + 'static); #[inline] fn next(&mut self) -> Option { let current = self.current; - self.current = self.current.and_then(Error::source); + self.current = self.current.and_then(StdError::source); current } } -impl std::ops::Deref for ChainError { +impl std::ops::Deref for Error { type Target = T; #[inline] @@ -440,572 +315,248 @@ impl std::ops::Deref for ChainError { } } -/// Convenience trait to hide the `ChainError` implementation internals -pub trait ChainErrorDown { - /// Test if of type `ChainError` +/// Convenience trait to hide the [`Error`](Error) implementation internals +pub trait ErrorDown { + /// Test if of type `Error` fn is_chain(&self) -> bool; - /// Downcast to a reference of `ChainError` - fn downcast_chain_ref(&self) -> Option<&ChainError>; - /// Downcast to a mutable reference of `ChainError` - fn downcast_chain_mut(&mut self) -> Option<&mut ChainError>; - /// Downcast to T of `ChainError` - fn downcast_inner_ref(&self) -> Option<&T>; - /// Downcast to T mutable reference of `ChainError` - fn downcast_inner_mut(&mut self) -> Option<&mut T>; + /// Downcast to a reference of `Error` + fn downcast_chain_ref(&self) -> Option<&Error>; + /// Downcast to a mutable reference of `Error` + fn downcast_chain_mut(&mut self) -> Option<&mut Error>; + /// Downcast to T of `Error` + fn downcast_inner_ref(&self) -> Option<&T>; + /// Downcast to T mutable reference of `Error` + fn downcast_inner_mut(&mut self) -> Option<&mut T>; } -impl ChainErrorDown for ChainError { +impl ErrorDown for Error { #[inline] fn is_chain(&self) -> bool { TypeId::of::() == TypeId::of::() } #[inline] - fn downcast_chain_ref(&self) -> Option<&ChainError> { + fn downcast_chain_ref(&self) -> Option<&Error> { if self.is_chain::() { - #[allow(clippy::cast_ptr_alignment)] - unsafe { - #[allow(trivial_casts)] - Some(&*(self as *const dyn Error as *const &ChainError)) - } + // Use transmute when we've verified the types match + unsafe { Some(std::mem::transmute::<&Error, &Error>(self)) } } else { None } } #[inline] - fn downcast_chain_mut(&mut self) -> Option<&mut ChainError> { + fn downcast_chain_mut(&mut self) -> Option<&mut Error> { if self.is_chain::() { - #[allow(clippy::cast_ptr_alignment)] - unsafe { - #[allow(trivial_casts)] - Some(&mut *(self as *mut dyn Error as *mut &mut ChainError)) - } + // Use transmute when we've verified the types match + unsafe { Some(std::mem::transmute::<&mut Error, &mut Error>(self)) } } else { None } } #[inline] - fn downcast_inner_ref(&self) -> Option<&T> { + fn downcast_inner_ref(&self) -> Option<&T> { if self.is_chain::() { - #[allow(clippy::cast_ptr_alignment)] - unsafe { - #[allow(trivial_casts)] - Some(&(*(self as *const dyn Error as *const &ChainError)).kind) - } + // Use transmute when we've verified the types match + unsafe { Some(std::mem::transmute::<&U, &T>(&self.kind)) } } else { None } } #[inline] - fn downcast_inner_mut(&mut self) -> Option<&mut T> { + fn downcast_inner_mut(&mut self) -> Option<&mut T> { if self.is_chain::() { - #[allow(clippy::cast_ptr_alignment)] - unsafe { - #[allow(trivial_casts)] - Some(&mut (*(self as *mut dyn Error as *mut &mut ChainError)).kind) - } + // Use transmute when we've verified the types match + unsafe { Some(std::mem::transmute::<&mut U, &mut T>(&mut self.kind)) } } else { None } } } -impl ChainErrorDown for dyn Error + 'static { +impl ErrorDown for dyn StdError + 'static { #[inline] fn is_chain(&self) -> bool { - self.is::>() + self.is::>() } #[inline] - fn downcast_chain_ref(&self) -> Option<&ChainError> { - self.downcast_ref::>() + fn downcast_chain_ref(&self) -> Option<&Error> { + self.downcast_ref::>() } #[inline] - fn downcast_chain_mut(&mut self) -> Option<&mut ChainError> { - self.downcast_mut::>() + fn downcast_chain_mut(&mut self) -> Option<&mut Error> { + self.downcast_mut::>() } #[inline] - fn downcast_inner_ref(&self) -> Option<&T> { + fn downcast_inner_ref(&self) -> Option<&T> { self.downcast_ref::() - .or_else(|| self.downcast_ref::>().map(|e| e.kind())) + .or_else(|| self.downcast_ref::>().map(|e| e.kind())) } #[inline] - fn downcast_inner_mut(&mut self) -> Option<&mut T> { + fn downcast_inner_mut(&mut self) -> Option<&mut T> { if self.is::() { return self.downcast_mut::(); } - self.downcast_mut::>() + self.downcast_mut::>() .and_then(|e| e.downcast_inner_mut::()) } } -impl ChainErrorDown for dyn Error + 'static + Send { +impl ErrorDown for dyn StdError + 'static + Send { #[inline] fn is_chain(&self) -> bool { - self.is::>() + self.is::>() } #[inline] - fn downcast_chain_ref(&self) -> Option<&ChainError> { - self.downcast_ref::>() + fn downcast_chain_ref(&self) -> Option<&Error> { + self.downcast_ref::>() } #[inline] - fn downcast_chain_mut(&mut self) -> Option<&mut ChainError> { - self.downcast_mut::>() + fn downcast_chain_mut(&mut self) -> Option<&mut Error> { + self.downcast_mut::>() } #[inline] - fn downcast_inner_ref(&self) -> Option<&T> { + fn downcast_inner_ref(&self) -> Option<&T> { self.downcast_ref::() - .or_else(|| self.downcast_ref::>().map(|e| e.kind())) + .or_else(|| self.downcast_ref::>().map(|e| e.kind())) } #[inline] - fn downcast_inner_mut(&mut self) -> Option<&mut T> { + fn downcast_inner_mut(&mut self) -> Option<&mut T> { if self.is::() { return self.downcast_mut::(); } - self.downcast_mut::>() + self.downcast_mut::>() .and_then(|e| e.downcast_inner_mut::()) } } -impl ChainErrorDown for dyn Error + 'static + Send + Sync { +impl ErrorDown for dyn StdError + 'static + Send + Sync { #[inline] fn is_chain(&self) -> bool { - self.is::>() + self.is::>() } #[inline] - fn downcast_chain_ref(&self) -> Option<&ChainError> { - self.downcast_ref::>() + fn downcast_chain_ref(&self) -> Option<&Error> { + self.downcast_ref::>() } #[inline] - fn downcast_chain_mut(&mut self) -> Option<&mut ChainError> { - self.downcast_mut::>() + fn downcast_chain_mut(&mut self) -> Option<&mut Error> { + self.downcast_mut::>() } #[inline] - fn downcast_inner_ref(&self) -> Option<&T> { + fn downcast_inner_ref(&self) -> Option<&T> { self.downcast_ref::() - .or_else(|| self.downcast_ref::>().map(|e| e.kind())) + .or_else(|| self.downcast_ref::>().map(|e| e.kind())) } #[inline] - fn downcast_inner_mut(&mut self) -> Option<&mut T> { + fn downcast_inner_mut(&mut self) -> Option<&mut T> { if self.is::() { return self.downcast_mut::(); } - self.downcast_mut::>() + self.downcast_mut::>() .and_then(|e| e.downcast_inner_mut::()) } } -impl Error for ChainError { +impl StdError for Error { #[inline] - fn source(&self) -> Option<&(dyn Error + 'static)> { + fn source(&self) -> Option<&(dyn StdError + 'static)> { self.error_cause .as_ref() - .map(|e| e.as_ref() as &(dyn Error + 'static)) + .map(|e| e.as_ref() as &(dyn StdError + 'static)) } } -impl Error for &ChainError { +impl StdError for &mut Error { #[inline] - fn source(&self) -> Option<&(dyn Error + 'static)> { + fn source(&self) -> Option<&(dyn StdError + 'static)> { self.error_cause .as_ref() - .map(|e| e.as_ref() as &(dyn Error + 'static)) + .map(|e| e.as_ref() as &(dyn StdError + 'static)) } } -impl Error for &mut ChainError { +impl Display for Error { #[inline] - fn source(&self) -> Option<&(dyn Error + 'static)> { - self.error_cause - .as_ref() - .map(|e| e.as_ref() as &(dyn Error + 'static)) - } -} - -impl Display for ChainError { - #[inline] - fn fmt(&self, f: &mut Formatter<'_>) -> Result { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { write!(f, "{}", self.kind)?; - #[cfg(feature = "display-cause")] - { + if f.alternate() { if let Some(e) = self.source() { - writeln!(f, "\nCaused by:")?; - Display::fmt(&e, f)?; + write!(f, "\nCaused by:\n {:#}", &e)?; } } + Ok(()) } } -impl Debug for ChainError { +impl Debug for Error { #[inline] - fn fmt(&self, f: &mut Formatter<'_>) -> Result { - #[cfg(not(feature = "no-fileline"))] - { - if let Some(ref o) = self.occurrence { - Display::fmt(o, f)?; - } - } + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + if f.alternate() { + let mut f = f.debug_struct(&format!("Error<{}>", std::any::type_name::())); - if self.is_chain::() { - Display::fmt(&self.kind, f)?; + let f = f + .field("occurrence", &self.occurrence) + .field("kind", &self.kind) + .field("source", &self.source()); + + f.finish() } else { - Debug::fmt(&self.kind, f)?; - } - - #[cfg(not(feature = "no-debug-cause"))] - { - if let Some(e) = self.source() { - writeln!(f, "\nCaused by:")?; - Debug::fmt(&e, f)?; + if let Some(ref o) = self.occurrence { + write!(f, "{}: ", o)?; } + + if TypeId::of::() == TypeId::of::() + || TypeId::of::<&str>() == TypeId::of::() + { + Display::fmt(&self.kind, f)?; + } else { + Debug::fmt(&self.kind, f)?; + } + + if let Some(e) = self.source() { + write!(f, "\nCaused by:\n{:?}", &e)?; + } + Ok(()) } - Ok(()) } } -/// `ChainErrorFrom` is similar to `From` -pub trait ChainErrorFrom: Sized { - /// similar to From::from() - fn chain_error_from(from: T, line_filename: Option<&'static str>) -> ChainError; -} - -/// `IntoChainError` is similar to `Into` -pub trait IntoChainError: Sized { - /// similar to Into::into() - fn into_chain_error(self, line_filename: Option<&'static str>) -> ChainError; -} - -impl IntoChainError for T +impl From for Error where - U: ChainErrorFrom, + T: 'static + Display + Debug, { + #[track_caller] #[inline] - fn into_chain_error(self, line_filename: Option<&'static str>) -> ChainError { - U::chain_error_from(self, line_filename) + fn from(e: T) -> Error { + Error::new(e, None, Some(Location::caller().to_string())) } } - -impl ChainErrorFrom for U -where - T: Into, - U: 'static + Display + Debug, -{ - #[inline] - fn chain_error_from(t: T, line_filename: Option<&'static str>) -> ChainError { - let e: U = t.into(); - ChainError::new(e, None, line_filename) - } -} - -/* -impl ChainErrorFrom for U - where - T: 'static + Error + Into> + Clone, - U: 'static + Display + Debug + From, -{ - #[inline] - fn chain_error_from(t: T, line_filename: Option<&'static str>) -> ChainError { - ChainError::new(U::from(t.clone()), Some(Box::from(t)), line_filename) - } -} -*/ - -/// map into `ChainError` with `T::from(err)` -/// -/// adds `line!()` and `file!()` information -#[macro_export] -macro_rules! minto_cherr { - ( $k:ident ) => ( - |e| $crate::cherr!(e, $k::from(&e)) - ); - ( $enum:ident $(:: $enum_path:ident)* ) => ( - |e| $crate::cherr!(e, $enum $(:: $enum_path)*::from(&e)) - ); -} - -/// Creates a new `ChainError` -/// -/// # Examples -/// -/// Create a new ChainError, where `FooError` must implement `Display` and `Debug`. -/// ```rust -/// # use chainerror::*; -/// # #[derive(Debug)] -/// enum FooError { -/// Bar, -/// Baz(&'static str), -/// } -/// # impl ::std::fmt::Display for FooError { -/// # fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { -/// # match self { -/// # FooError::Bar => write!(f, "Bar Error"), -/// # FooError::Baz(s) => write!(f, "Baz Error: '{}'", s), -/// # } -/// # } -/// # } -/// -/// // impl ::std::fmt::Display for FooError -/// -/// fn do_some_stuff() -> bool { -/// false -/// } -/// -/// fn func() -> ChainResult<(), FooError> { -/// if ! do_some_stuff() { -/// Err(cherr!(FooError::Baz("Error")))?; -/// } -/// Ok(()) -/// } -/// # pub fn main() { -/// # match func().unwrap_err().kind() { -/// # FooError::Baz(s) if s == &"Error" => {} -/// # _ => panic!(), -/// # } -/// # } -/// ``` -/// -/// Additionally an error cause can be added. -/// -/// ```rust -/// # use chainerror::*; -/// # use std::io; -/// # use std::error::Error; -/// # #[derive(Debug)] -/// # enum FooError { -/// # Bar, -/// # Baz(&'static str), -/// # } -/// # impl ::std::fmt::Display for FooError { -/// # fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { -/// # match self { -/// # FooError::Bar => write!(f, "Bar Error"), -/// # FooError::Baz(s) => write!(f, "Baz Error: '{}'", s), -/// # } -/// # } -/// # } -/// fn do_some_stuff() -> Result<(), Box> { -/// Err(io::Error::from(io::ErrorKind::NotFound))?; -/// Ok(()) -/// } -/// -/// fn func() -> ChainResult<(), FooError> { -/// do_some_stuff().map_err( -/// |e| cherr!(e, FooError::Baz("Error")) -/// )?; -/// Ok(()) -/// } -/// # pub fn main() { -/// # match func().unwrap_err().kind() { -/// # FooError::Baz(s) if s == &"Error" => {} -/// # _ => panic!(), -/// # } -/// # } -/// ``` -#[macro_export] -macro_rules! cherr { - ( $k:expr ) => ({ - $crate::ChainError::new($k, None, Some(concat!(file!(), ":", line!(), ": "))) - }); - ( None, $k:expr ) => ({ - $crate::ChainError::new($k, None, Some(concat!(file!(), ":", line!(), ": "))) - }); - ( None, $fmt:expr, $($arg:tt)+ ) => ({ - $crate::cherr!(None, format!($fmt, $($arg)+ )) - }); - ( None, $fmt:expr, $($arg:tt)+ ) => ({ - $crate::cherr!(None, format!($fmt, $($arg)+ )) - }); - ( $e:path, $k:expr ) => ({ - $crate::ChainError::new($k, Some(Box::from($e)), Some(concat!(file!(), ":", line!(), ": "))) - }); - ( $e:path, $fmt:expr, $($arg:tt)+ ) => ({ - $crate::cherr!($e, format!($fmt, $($arg)+ )) - }); -} - -/// Convenience macro for `|e| cherr!(e, format!(…))` -/// -/// # Examples -/// -/// ```rust -/// # use crate::chainerror::*; -/// # use std::error::Error; -/// # use std::io; -/// # use std::result::Result; -/// # fn do_some_io() -> Result<(), Box> { -/// # Err(io::Error::from(io::ErrorKind::NotFound))?; -/// # Ok(()) -/// # } -/// fn func2() -> Result<(), Box> { -/// let filename = "foo.txt"; -/// do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?; -/// Ok(()) -/// } -/// -/// fn func1() -> Result<(), Box> { -/// func2().map_err(mstrerr!("func1 error"))?; -/// Ok(()) -/// } -/// -/// # fn main() { -/// # if let Err(e) = func1() { -/// # #[cfg(not(windows))] -/// # assert_eq!( -/// # format!("\n{:?}\n", e), r#" -/// # src/lib.rs:18: func1 error -/// # Caused by: -/// # src/lib.rs:13: Error reading 'foo.txt' -/// # Caused by: -/// # Kind(NotFound) -/// # "# -/// # ); -/// # } else { -/// # unreachable!(); -/// # } -/// # } -/// ``` -/// -/// `mstrerr!()` can also be used to map a new `ChainError`, where T was defined with -/// `derive_str_cherr!(T)` -/// -/// ```rust -/// # use crate::chainerror::*; -/// # use std::error::Error; -/// # use std::io; -/// # use std::result::Result; -/// # fn do_some_io() -> Result<(), Box> { -/// # Err(io::Error::from(io::ErrorKind::NotFound))?; -/// # Ok(()) -/// # } -/// derive_str_cherr!(Func2Error); -/// -/// fn func2() -> Result<(), Box> { -/// let filename = "foo.txt"; -/// do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; -/// Ok(()) -/// } -/// -/// derive_str_cherr!(Func1Error); -/// -/// fn func1() -> Result<(), Box> { -/// func2().map_err(mstrerr!(Func1Error, "func1 error"))?; -/// Ok(()) -/// } -/// # fn main() { -/// # if let Err(e) = func1() { -/// # if let Some(f1err) = e.downcast_chain_ref::() { -/// # assert!(f1err.find_cause::>().is_some()); -/// # assert!(f1err.find_chain_cause::().is_some()); -/// # } else { -/// # panic!(); -/// # } -/// # } else { -/// # unreachable!(); -/// # } -/// # } -/// ``` -#[macro_export] -macro_rules! mstrerr { - ( $t:path, $msg:expr ) => ({ - |e| $crate::cherr!(e, $t ($msg.to_string())) - }); - ( $t:path, $msg:expr, ) => ({ - |e| $crate::cherr!(e, $t ($msg.to_string())) - }); - ( $t:path, $fmt:expr, $($arg:tt)+ ) => ({ - |e| $crate::cherr!(e, $t (format!($fmt, $($arg)+ ))) - }); - ($msg:expr) => ({ - |e| $crate::cherr!(e, $msg.to_string()) - }); - ($msg:expr, ) => ({ - |e| $crate::cherr!(e, $msg.to_string()) - }); - ($fmt:expr, $($arg:tt)+) => ({ - |e| $crate::cherr!(e, format!($fmt, $($arg)+ )) - }); -} - -/// Convenience macro for `cherr!(T(format!(…)))` where `T(String)` -/// -/// # Examples -/// -/// ```rust -/// # use crate::chainerror::*; -/// # use std::error::Error; -/// # use std::result::Result; -/// derive_str_cherr!(Func2Error); -/// -/// fn func2() -> ChainResult<(), Func2Error> { -/// let filename = "foo.txt"; -/// Err(strerr!(Func2Error, "Error reading '{}'", filename)) -/// } -/// -/// derive_str_cherr!(Func1Error); -/// -/// fn func1() -> Result<(), Box> { -/// func2().map_err(mstrerr!(Func1Error, "func1 error"))?; -/// Ok(()) -/// } -/// # fn main() { -/// # if let Err(e) = func1() { -/// # if let Some(f1err) = e.downcast_chain_ref::() { -/// # assert!(f1err.find_cause::>().is_some()); -/// # assert!(f1err.find_chain_cause::().is_some()); -/// # } else { -/// # panic!(); -/// # } -/// # } else { -/// # unreachable!(); -/// # } -/// # } -/// ``` -#[macro_export] -macro_rules! strerr { - ( $t:path, $msg:expr ) => ({ - $crate::cherr!($t ($msg.to_string())) - }); - ( $t:path, $msg:expr, ) => ({ - $crate::cherr!($t ($msg.to_string())) - }); - ( $t:path, $fmt:expr, $($arg:tt)+ ) => ({ - $crate::cherr!($t (format!($fmt, $($arg)+ ))) - }); - ($msg:expr) => ({ - $crate::cherr!($msg.to_string()) - }); - ($msg:expr, ) => ({ - $crate::cherr!($msg.to_string()) - }); - ($fmt:expr, $($arg:tt)+) => ({ - $crate::cherr!(format!($fmt, $($arg)+ )) - }); -} - /// Convenience macro to create a "new type" T(String) and implement Display + Debug for T /// /// # Examples /// /// ```rust -/// # use crate::chainerror::*; +/// # use chainerror::Context as _; +/// # use chainerror::ErrorDown as _; /// # use std::error::Error; /// # use std::io; /// # use std::result::Result; @@ -1013,24 +564,23 @@ macro_rules! strerr { /// # Err(io::Error::from(io::ErrorKind::NotFound))?; /// # Ok(()) /// # } -/// derive_str_cherr!(Func2Error); +/// chainerror::str_context!(Func2Error); /// -/// fn func2() -> ChainResult<(), Func2Error> { +/// fn func2() -> chainerror::Result<(), Func2Error> { /// let filename = "foo.txt"; -/// do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?; +/// do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?; /// Ok(()) /// } /// -/// derive_str_cherr!(Func1Error); +/// chainerror::str_context!(Func1Error); /// /// fn func1() -> Result<(), Box> { -/// func2().map_err(mstrerr!(Func1Error, "func1 error"))?; +/// func2().context(Func1Error::new("func1 error"))?; /// Ok(()) /// } -/// # fn main() { /// # if let Err(e) = func1() { /// # if let Some(f1err) = e.downcast_chain_ref::() { -/// # assert!(f1err.find_cause::>().is_some()); +/// # assert!(f1err.find_cause::>().is_some()); /// # assert!(f1err.find_chain_cause::().is_some()); /// # } else { /// # panic!(); @@ -1038,13 +588,18 @@ macro_rules! strerr { /// # } else { /// # unreachable!(); /// # } -/// # } /// ``` #[macro_export] -macro_rules! derive_str_cherr { +macro_rules! str_context { ($e:ident) => { #[derive(Clone)] pub struct $e(pub String); + impl $e { + #[allow(dead_code)] + pub fn new>(s: S) -> Self { + $e(s.into()) + } + } impl ::std::fmt::Display for $e { fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result { write!(f, "{}", self.0) @@ -1059,9 +614,9 @@ macro_rules! derive_str_cherr { }; } -/// Derive an Error for an ErrorKind, which wraps a `ChainError` and implements a `kind()` method +/// Derive an Error for an ErrorKind, which wraps a [`Error`](Error) and implements a `kind()` method /// -/// It basically hides `ChainError` to the outside and only exposes the `kind()` +/// It basically hides [`Error`](Error) to the outside and only exposes the [`kind()`](Error::kind) /// method. /// /// Error::kind() returns the ErrorKind @@ -1070,8 +625,8 @@ macro_rules! derive_str_cherr { /// # Examples /// /// ```rust +/// use chainerror::Context as _; /// use std::io; -/// use chainerror::*; /// /// fn do_some_io(_f: &str) -> std::result::Result<(), io::Error> { /// return Err(io::Error::from(io::ErrorKind::NotFound)); @@ -1084,7 +639,7 @@ macro_rules! derive_str_cherr { /// Unknown, /// } /// -/// derive_err_kind!(Error, ErrorKind); +/// chainerror::err_kind!(Error, ErrorKind); /// /// impl std::fmt::Display for ErrorKind { /// fn fmt(&self, f: &mut ::std::fmt::Formatter) -> std::fmt::Result { @@ -1117,18 +672,22 @@ macro_rules! derive_str_cherr { /// pub fn func1() -> std::result::Result<(), Error> { /// let filename = "bar.txt"; /// -/// do_some_io(filename) -/// .map_err(|e| cherr!(e, ErrorKind::from_io_error(&e, filename.into())))?; -/// do_some_io(filename).map_err(|e| cherr!(e, ErrorKind::IO(filename.into())))?; -/// do_some_io(filename).map_err(|e| cherr!(e, ErrorKind::from(&e)))?; -/// do_some_io(filename).map_err(minto_cherr!(ErrorKind))?; +/// do_some_io(filename).map_context(|e| ErrorKind::from_io_error(e, filename.into()))?; +/// do_some_io(filename).map_context(|e| ErrorKind::IO(filename.into()))?; +/// do_some_io(filename).map_context(|e| ErrorKind::from(e))?; /// Ok(()) /// } +/// +/// # fn main() { +/// # if let Err(e) = func1() { +/// # eprintln!("Error:\n{:?}", e); +/// # } +/// # } /// ``` #[macro_export] -macro_rules! derive_err_kind { +macro_rules! err_kind { ($e:ident, $k:ident) => { - pub struct $e($crate::ChainError<$k>); + pub struct $e($crate::Error<$k>); impl $e { pub fn kind(&self) -> &$k { @@ -1138,12 +697,12 @@ macro_rules! derive_err_kind { impl From<$k> for $e { fn from(e: $k) -> Self { - $e($crate::ChainError::new(e, None, None)) + $e($crate::Error::new(e, None, None)) } } - impl From> for $e { - fn from(e: $crate::ChainError<$k>) -> Self { + impl From<$crate::Error<$k>> for $e { + fn from(e: $crate::Error<$k>) -> Self { $e(e) } } @@ -1157,19 +716,6 @@ macro_rules! derive_err_kind { } } - impl $crate::ChainErrorFrom<$e> for $k - where - $k: Clone, - { - #[inline] - fn chain_error_from( - t: $e, - line_filename: Option<&'static str>, - ) -> $crate::ChainError<$k> { - $crate::ChainError::new((*t.kind()).clone(), Some(Box::from(t)), line_filename) - } - } - impl std::error::Error for $e { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { self.0.source() @@ -1189,3 +735,291 @@ macro_rules! derive_err_kind { } }; } + +#[cfg(test)] +mod tests { + use super::Context as _; + use super::*; + use std::io; + + #[test] + fn test_error_chain_with_multiple_causes() { + // Create a chain of errors + let io_error = io::Error::new(io::ErrorKind::NotFound, "file not found"); + + str_context!(Level3Error); + str_context!(Level2Error); + str_context!(Level1Error); + + let err = Result::<(), _>::Err(io_error.into()) + .context(Level3Error("level 3".into())) + .context(Level2Error("level 2".into())) + .context(Level1Error("level 1".into())) + .unwrap_err(); + + // Test the error chain + assert!(err.is_chain::()); + assert!(err.find_chain_cause::().is_some()); + assert!(err.find_chain_cause::().is_some()); + assert!(err.find_chain_cause::().is_some()); + } + + #[test] + fn test_error_root_cause() { + let io_error = io::Error::new(io::ErrorKind::NotFound, "file not found"); + + str_context!(WrapperError); + let err = Result::<(), _>::Err(io_error.into()) + .context(WrapperError("wrapper".into())) + .unwrap_err(); + + let root = err.root_cause().unwrap(); + assert!(root.is_chain::()); + } + + #[test] + fn test_error_display_and_debug() { + str_context!(CustomError); + let err = Error::new( + CustomError("test error".into()), + None, + Some("src/lib.rs:100".into()), + ); + + // Test Display formatting + assert_eq!(format!("{}", err), "test error"); + + // Test alternate Display formatting + assert_eq!(format!("{:#}", err), "test error"); + + // Test Debug formatting + let debug_output = format!("{:?}", err); + assert!(debug_output.contains("test error")); + assert!(debug_output.contains("src/lib.rs:100")); + } + + #[test] + fn test_error_annotation() { + let io_error = io::Error::new(io::ErrorKind::NotFound, "file not found"); + let err = Result::<(), _>::Err(io_error.into()) + .annotate() + .unwrap_err(); + + assert!(err.source().is_some()); + err.source() + .unwrap() + .downcast_inner_ref::() + .unwrap(); + } + + #[test] + fn test_map_context() { + let io_error = io::Error::new(io::ErrorKind::NotFound, "file not found"); + + str_context!(MappedError); + let err = Result::<(), _>::Err(io_error.into()) + .map_context(|e| MappedError(format!("Mapped: {}", e))) + .unwrap_err(); + + assert!(err.is_chain::()); + assert!(err.find_chain_cause::().is_some()); + } + + #[test] + fn test_error_downcasting() { + str_context!(OriginalError); + let original = Error::new(OriginalError("test".into()), None, None); + + let error: Box = Box::new(original); + + // Test downcast_chain_ref + assert!(error.is_chain::()); + assert!(error.downcast_chain_ref::().is_some()); + + // Test downcast_inner_ref + let inner = error.downcast_inner_ref::(); + assert!(inner.is_some()); + } + + #[derive(Debug, Clone)] + enum TestErrorKind { + Basic(String), + Complex { message: String }, + } + + impl Display for TestErrorKind { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + match self { + TestErrorKind::Basic(msg) => write!(f, "Basic error: {}", msg), + TestErrorKind::Complex { message } => write!(f, "Complex error: {}", message), + } + } + } + + #[test] + fn test_err_kind_macro() { + err_kind!(TestError, TestErrorKind); + + let err = TestError::from(TestErrorKind::Basic("test".into())); + assert!(matches!(err.kind(), TestErrorKind::Basic(_))); + // The annotated error should display "(passed error)" even in a chain + assert_eq!(format!("{}", err), "Basic error: test"); + assert_eq!(format!("{:?}", err), "Basic(\"test\")"); + + let complex_err = TestError::from(TestErrorKind::Complex { + message: "test".into(), + }); + assert!(matches!(complex_err.kind(), TestErrorKind::Complex { .. })); + // The annotated error should display "(passed error)" even in a chain + assert_eq!(format!("{}", complex_err), "Complex error: test"); + assert_eq!( + format!("{:?}", complex_err), + "Complex { message: \"test\" }" + ); + } + #[test] + fn test_annotated_error_display_and_debug() { + let annotated = AnnotatedError(()); + + // Test Display formatting + assert_eq!(format!("{}", annotated), "(passed error)"); + + // Test Debug formatting + assert_eq!(format!("{:?}", annotated), "(passed error)"); + + // Test with error chain + let io_error = io::Error::new(io::ErrorKind::NotFound, "file not found"); + let err = Result::<(), _>::Err(io_error.into()) + .annotate() + .unwrap_err(); + + // The annotated error should display "(passed error)" even in a chain + assert_eq!(format!("{}", err), "(passed error)"); + assert!(format!("{:?}", err).contains("(passed error)")); + + // Verify the error chain is preserved + assert!(err.source().is_some()); + assert!(err.source().unwrap().is_chain::()); + } + + // Helper error types for testing + #[derive(Debug)] + struct TestError(String); + + impl std::fmt::Display for TestError { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.0) + } + } + + impl std::error::Error for TestError {} + + #[test] + fn test_downcast_chain_operations() { + // Create a test error chain + let original_error = Error::new( + TestError("test message".to_string()), + None, + Some("test location".to_string()), + ); + + // Test is_chain + assert!(original_error.is_chain::()); + assert!(!original_error.is_chain::()); + + // Test downcast_chain_ref + let downcast_ref = original_error.downcast_chain_ref::(); + assert!(downcast_ref.is_some()); + let downcast_kind = downcast_ref.unwrap().kind(); + assert_eq!(format!("{}", downcast_kind), "test message"); + assert_eq!( + format!("{:?}", downcast_kind), + "TestError(\"test message\")" + ); + + // Test invalid downcast_chain_ref + let invalid_downcast = original_error.downcast_chain_ref::(); + assert!(invalid_downcast.is_none()); + + // Test downcast_chain_mut + let mut mutable_error = original_error; + let downcast_mut = mutable_error.downcast_chain_mut::(); + assert!(downcast_mut.is_some()); + assert_eq!(downcast_mut.unwrap().kind().0, "test message"); + + // Test invalid downcast_chain_mut + let invalid_downcast_mut = mutable_error.downcast_chain_mut::(); + assert!(invalid_downcast_mut.is_none()); + } + + #[test] + fn test_downcast_inner_operations() { + // Create a test error + let mut error = Error::new( + TestError("inner test".to_string()), + None, + Some("test location".to_string()), + ); + + // Test downcast_inner_ref + let inner_ref = error.downcast_inner_ref::(); + assert!(inner_ref.is_some()); + assert_eq!(inner_ref.unwrap().0, "inner test"); + // Test invalid downcast_inner_ref + let invalid_inner = error.downcast_inner_ref::(); + assert!(invalid_inner.is_none()); + + // Test downcast_inner_mut + let inner_mut = error.downcast_inner_mut::(); + assert!(inner_mut.is_some()); + assert_eq!(inner_mut.unwrap().0, "inner test"); + + // Test invalid downcast_inner_mut + let invalid_inner_mut = error.downcast_inner_mut::(); + assert!(invalid_inner_mut.is_none()); + } + + #[test] + fn test_error_down_for_dyn_error() { + // Create a boxed error + let error: Box = Box::new(Error::new( + TestError("dyn test".to_string()), + None, + Some("test location".to_string()), + )); + + // Test is_chain through trait object + assert!(error.is_chain::()); + assert!(!error.is_chain::()); + + // Test downcast_chain_ref through trait object + let chain_ref = error.downcast_chain_ref::(); + assert!(chain_ref.is_some()); + assert_eq!(chain_ref.unwrap().kind().0, "dyn test"); + + // Test downcast_inner_ref through trait object + let inner_ref = error.downcast_inner_ref::(); + assert!(inner_ref.is_some()); + assert_eq!(inner_ref.unwrap().0, "dyn test"); + } + + #[test] + fn test_error_down_with_sync_send() { + // Create a boxed error with Send + Sync + let error: Box = Box::new(Error::new( + TestError("sync test".to_string()), + None, + Some("test location".to_string()), + )); + + // Test operations on Send + Sync error + assert!(error.is_chain::()); + assert!(error.downcast_chain_ref::().is_some()); + assert!(error.downcast_inner_ref::().is_some()); + + // Test invalid downcasts + assert!(!error.is_chain::()); + assert!(error.downcast_chain_ref::().is_none()); + assert!(error.downcast_inner_ref::().is_none()); + } +} diff --git a/tests/test_basic.rs b/tests/test_basic.rs new file mode 100644 index 0000000..bbc9f16 --- /dev/null +++ b/tests/test_basic.rs @@ -0,0 +1,33 @@ +use chainerror::Context; + +#[test] +fn test_basic() { + use std::path::PathBuf; + type BoxedError = Box; + fn read_config_file(path: PathBuf) -> Result<(), BoxedError> { + // do stuff, return other errors + let _buf = std::fs::read_to_string(&path).context(format!("Reading file: {:?}", &path))?; + // do stuff, return other errors + Ok(()) + } + fn process_config_file() -> Result<(), BoxedError> { + // do stuff, return other errors + read_config_file("_non_existent.txt".into()).context("read the config file")?; + // do stuff, return other errors + Ok(()) + } + + if let Err(e) = process_config_file() { + let os_notfound_error = std::io::Error::from_raw_os_error(2); + let s = format!("{:?}", e); + let lines = s.lines().collect::>(); + assert_eq!(lines.len(), 5); + assert!(lines[0].starts_with("tests/test_basic.rs:")); + assert_eq!(lines[1], "Caused by:"); + assert!(lines[2].starts_with("tests/test_basic.rs:")); + assert_eq!(lines[3], "Caused by:"); + assert_eq!(lines[4], format!("{:?}", os_notfound_error)); + } else { + panic!(); + } +} diff --git a/tests/test_iter.rs b/tests/test_iter.rs index 488ed0b..9023078 100644 --- a/tests/test_iter.rs +++ b/tests/test_iter.rs @@ -1,28 +1,54 @@ -use chainerror::*; +use chainerror::Context; use std::error::Error; -use std::fmt::Write; use std::io; #[test] fn test_iter() -> Result<(), Box> { - let err = io::Error::from(io::ErrorKind::NotFound); - let err = cherr!(err, "1"); - let err = cherr!(err, "2"); - let err = cherr!(err, "3"); - let err = cherr!(err, "4"); - let err = cherr!(err, "5"); - let err = cherr!(err, "6"); + use std::fmt::Write; + let err: Result<(), _> = Err(io::Error::from(io::ErrorKind::NotFound)); + let err = err.context("1"); + let err = err.context("2"); + let err = err.context("3"); + let err = err.context("4"); + let err = err.context("5"); + let err = err.context("6"); + let err = err.err().unwrap(); let mut res = String::new(); for e in err.iter() { - write!(res, "{}", e.to_string())?; + write!(res, "{}", e)?; } assert_eq!(res, "654321entity not found"); let io_error: Option<&io::Error> = err .iter() - .filter_map(Error::downcast_ref::) + .filter_map(::downcast_ref::) + .next(); + + assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound); + + Ok(()) +} + +#[test] +fn test_iter_alternate() -> Result<(), Box> { + let err: Result<(), _> = Err(io::Error::from(io::ErrorKind::NotFound)); + let err = err.context("1"); + let err = err.context("2"); + let err = err.context("3"); + let err = err.context("4"); + let err = err.context("5"); + let err = err.context("6"); + let err = err.err().unwrap(); + + let res = format!("{:#}", err); + + assert_eq!(res, format!("6\nCaused by:\n 5\nCaused by:\n 4\nCaused by:\n 3\nCaused by:\n 2\nCaused by:\n 1\nCaused by:\n {:#}", io::Error::from(io::ErrorKind::NotFound))); + + let io_error: Option<&io::Error> = err + .iter() + .filter_map(::downcast_ref::) .next(); assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound); @@ -32,13 +58,14 @@ fn test_iter() -> Result<(), Box> { #[test] fn test_find_cause() -> Result<(), Box> { - let err = io::Error::from(io::ErrorKind::NotFound); - let err = cherr!(err, "1"); - let err = cherr!(err, "2"); - let err = cherr!(err, "3"); - let err = cherr!(err, "4"); - let err = cherr!(err, "5"); - let err = cherr!(err, "6"); + let err: Result<(), _> = Err(io::Error::from(io::ErrorKind::NotFound)); + let err = err.context("1"); + let err = err.context("2"); + let err = err.context("3"); + let err = err.context("4"); + let err = err.context("5"); + let err = err.context("6"); + let err = err.err().unwrap(); let io_error: Option<&io::Error> = err.find_cause::(); @@ -49,16 +76,17 @@ fn test_find_cause() -> Result<(), Box> { #[test] fn test_root_cause() -> Result<(), Box> { - let err = io::Error::from(io::ErrorKind::NotFound); - let err = cherr!(err, "1"); - let err = cherr!(err, "2"); - let err = cherr!(err, "3"); - let err = cherr!(err, "4"); - let err = cherr!(err, "5"); - let err = cherr!(err, "6"); + let err: Result<(), _> = Err(io::Error::from(io::ErrorKind::NotFound)); + let err = err.context("1"); + let err = err.context("2"); + let err = err.context("3"); + let err = err.context("4"); + let err = err.context("5"); + let err = err.context("6"); + let err = err.err().unwrap(); let err: Option<&(dyn std::error::Error + 'static)> = err.root_cause(); - let io_error: Option<&io::Error> = err.and_then(Error::downcast_ref::); + let io_error: Option<&io::Error> = err.and_then(::downcast_ref::); assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound);