mirror of
https://github.com/haraldh/chainerror.git
synced 2025-04-19 14:22:52 +02:00
Compare commits
No commits in common. "master" and "v0.5.0" have entirely different histories.
7
.github/dependabot.yml
vendored
7
.github/dependabot.yml
vendored
|
@ -1,7 +0,0 @@
|
|||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: cargo
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: daily
|
||||
open-pull-requests-limit: 10
|
38
.github/workflows/coverage.yml
vendored
38
.github/workflows/coverage.yml
vendored
|
@ -1,38 +0,0 @@
|
|||
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
|
29
.github/workflows/gh-pages.yml
vendored
29
.github/workflows/gh-pages.yml
vendored
|
@ -7,19 +7,34 @@ on:
|
|||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
runs-on: ubuntu-18.04
|
||||
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
|
||||
|
||||
|
|
65
.github/workflows/rust.yml
vendored
65
.github/workflows/rust.yml
vendored
|
@ -1,72 +1,15 @@
|
|||
name: Rust
|
||||
|
||||
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
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
version:
|
||||
- 1.54.0
|
||||
- stable
|
||||
- beta
|
||||
- nightly
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Install toolchain
|
||||
uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ matrix.version }}
|
||||
profile: minimal
|
||||
- uses: actions/checkout@v2
|
||||
- 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
|
||||
|
|
22
.travis.yml
Normal file
22
.travis.yml
Normal file
|
@ -0,0 +1,22 @@
|
|||
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
|
17
Cargo.toml
17
Cargo.toml
|
@ -1,9 +1,9 @@
|
|||
[package]
|
||||
name = "chainerror"
|
||||
version = "1.0.0"
|
||||
version = "0.5.0"
|
||||
authors = ["Harald Hoyer <harald@redhat.com>"]
|
||||
edition = "2018"
|
||||
license = "MIT OR Apache-2.0"
|
||||
license = "MIT/Apache-2.0"
|
||||
documentation = "https://docs.rs/chainerror"
|
||||
homepage = "https://haraldh.github.io/chainerror/"
|
||||
repository = "https://github.com/haraldh/chainerror"
|
||||
|
@ -16,11 +16,10 @@ exclude = [ ".gitignore", "examples/*", "booksrc/*", "book.toml",
|
|||
"theme/*", "git-deploy-branch.sh", ".travis.yml" ]
|
||||
|
||||
[badges]
|
||||
# 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" }
|
||||
travis-ci = { repository = "haraldh/chainerror" }
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
|
||||
[features]
|
||||
default = [ ]
|
||||
no-fileline = []
|
||||
display-cause = []
|
||||
no-debug-cause = []
|
||||
|
|
261
README.md
261
README.md
|
@ -1,186 +1,129 @@
|
|||
[](https://crates.io/crates/chainerror)
|
||||
[](https://docs.rs/chainerror/)
|
||||
[](https://codecov.io/gh/haraldh/chainerror)
|
||||

|
||||
|
||||
# chainerror
|
||||
|
||||
`chainerror` provides an error backtrace without doing a real backtrace, so even after you `strip` your
|
||||
[](https://travis-ci.org/haraldh/chainerror)
|
||||
[](https://crates.io/crates/chainerror)
|
||||
[](https://docs.rs/chainerror/)
|
||||
|
||||
`chainerror` provides an error backtrace like `failure` without doing a real backtrace, so even after you `strip` your
|
||||
binaries, you still have the error backtrace.
|
||||
|
||||
Having nested function returning errors, the output doesn't tell where the error originates from.
|
||||
|
||||
```rust
|
||||
use std::path::PathBuf;
|
||||
|
||||
type BoxedError = Box<dyn std::error::Error + Send + Sync>;
|
||||
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 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) = 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.
|
||||
|
||||
|
||||
With `chainerror`, you can supply a context and get a nice error backtrace:
|
||||
|
||||
```rust
|
||||
use chainerror::Context as _;
|
||||
use std::path::PathBuf;
|
||||
|
||||
type BoxedError = Box<dyn std::error::Error + Send + Sync>;
|
||||
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<T>` struct, `chainerror` comes with some useful helper macros to save a lot of typing.
|
||||
|
||||
`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<T>` struct, `chainerror` comes with some useful helper macros to save a lot of typing.
|
||||
|
||||
Debug information is worth it!
|
||||
|
||||
## Multiple Output Formats
|
||||
Now continue reading the
|
||||
[Tutorial](https://haraldh.github.io/chainerror/tutorial1.html)
|
||||
|
||||
`chainerror` supports multiple output formats, which can be selected with the different format specifiers:
|
||||
## Example:
|
||||
Output:
|
||||
|
||||
* `{}`: Display
|
||||
```console
|
||||
func1 error calling func2
|
||||
```
|
||||
~~~
|
||||
$ cargo run -q --example example
|
||||
Main Error Report: 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
|
||||
```
|
||||
Error reported by Func2Error: func2 error: calling func3
|
||||
|
||||
* `{:?}`: Debug
|
||||
```console
|
||||
examples/example.rs:50:13: func1 error calling func2
|
||||
The root cause was: std::io::Error: Kind(
|
||||
NotFound
|
||||
)
|
||||
|
||||
Debug Error:
|
||||
examples/example.rs:45: func1 error calling func2
|
||||
Caused by:
|
||||
examples/example.rs:25:13: Func2Error(func2 error: calling func3)
|
||||
examples/example.rs:20: 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'
|
||||
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;
|
||||
|
||||
* `{:#?}`: Alternative Debug
|
||||
```console
|
||||
Error<example::Func1Error> {
|
||||
occurrence: Some(
|
||||
"examples/example.rs:50:13",
|
||||
),
|
||||
kind: func1 error calling func2,
|
||||
source: Some(
|
||||
Error<example::Func2Error> {
|
||||
occurrence: Some(
|
||||
"examples/example.rs:25:13",
|
||||
),
|
||||
kind: Func2Error(func2 error: calling func3),
|
||||
source: Some(
|
||||
Error<chainerror::AnnotatedError> {
|
||||
occurrence: Some(
|
||||
"examples/example.rs:18:13",
|
||||
),
|
||||
kind: (passed error),
|
||||
source: Some(
|
||||
Error<alloc::string::String> {
|
||||
occurrence: Some(
|
||||
"examples/example.rs:13:18",
|
||||
),
|
||||
kind: "Error reading 'foo.txt'",
|
||||
source: Some(
|
||||
Kind(
|
||||
NotFound,
|
||||
),
|
||||
),
|
||||
},
|
||||
),
|
||||
},
|
||||
),
|
||||
},
|
||||
),
|
||||
fn do_some_io() -> Result<(), Box<Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## Tutorial
|
||||
fn func3() -> Result<(), Box<Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
Read the [Tutorial](https://haraldh.github.io/chainerror/tutorial1.html)
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
## License
|
||||
fn func2() -> ChainResult<(), Func2Error> {
|
||||
func3().map_err(mstrerr!(Func2Error, "func2 error: calling func3"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
Licensed under either of
|
||||
enum Func1Error {
|
||||
Func2,
|
||||
IO(String),
|
||||
}
|
||||
|
||||
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
|
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
|
||||
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),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
at your option.
|
||||
impl ::std::fmt::Debug for Func1Error {
|
||||
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
|
||||
write!(f, "{}", self)
|
||||
}
|
||||
}
|
||||
|
||||
### Contribution
|
||||
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(())
|
||||
}
|
||||
|
||||
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.
|
||||
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::<Func2Error>() {
|
||||
eprintln!("\nError reported by Func2Error: {}", e)
|
||||
}
|
||||
|
||||
if let Some(e) = e.root_cause() {
|
||||
let ioerror = e.downcast_ref::<io::Error>().unwrap();
|
||||
eprintln!("\nThe root cause was: std::io::Error: {:#?}", ioerror);
|
||||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
}
|
||||
}
|
||||
|
||||
~~~
|
||||
|
||||
## 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`
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
../LICENSE-APACHE
|
|
@ -1 +0,0 @@
|
|||
../LICENSE-MIT
|
|
@ -5,7 +5,7 @@
|
|||
- [Simple String Errors](tutorial1.md)
|
||||
- [Simple Chained String Errors](tutorial2.md)
|
||||
- [Mapping Errors](tutorial3.md)
|
||||
- [More Information](tutorial4.md)
|
||||
- [Saving coding chars](tutorial4.md)
|
||||
- [The source() of Errors](tutorial5.md)
|
||||
- [Downcast the Errors](tutorial6.md)
|
||||
- [The root cause of all Errors](tutorial7.md)
|
||||
|
|
|
@ -9,7 +9,7 @@ this only
|
|||
prints out the last `Error`.
|
||||
|
||||
~~~
|
||||
Error: "func1 error"
|
||||
Error: StringError("func1 error")
|
||||
~~~
|
||||
|
||||
The next chapters of this tutorial show how `chainerror` adds more information
|
||||
|
|
|
@ -1,16 +1,20 @@
|
|||
# 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<Error + Send + Sync>>` and we can
|
||||
use `ChainResult<(), Func1ErrorKind>`.
|
||||
|
||||
In `main` we can now directly use the methods of `chainerror::Error<T>` without downcasting the error first.
|
||||
In `main` we can now directly use the methods of `ChainError<T>` without downcasting the error first.
|
||||
|
||||
Also, a nice `match` on `chainerror::Error<T>.kind()` is now possible, which returns `&T`, meaning `&Func1ErrorKind` here.
|
||||
Also a nice `match` on `ChainError<T>.kind()` is now possible, which returns `&T`, meaning
|
||||
`&Func1ErrorKind` here.
|
||||
|
||||
~~~rust
|
||||
{{#include ../examples/tutorial10.rs}}
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Debug for the ErrorKind
|
||||
|
||||
One small improvement is to fix the debug output of
|
||||
One small improvement at the end of the tutorial 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
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Deref for the ErrorKind
|
||||
|
||||
Because chainerror::Error<T> implements Deref to &T, we can also match on `*e` instead of `e.kind()`
|
||||
Because ChainError<T> 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}}
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Writing a library
|
||||
|
||||
I would advise to only expose an `mycrate::ErrorKind` and type alias `mycrate::Error` to `chainerror::Error<mycrate::ErrorKind>`
|
||||
I would advise to only expose an `mycrate::ErrorKind` and type alias `mycrate::Error` to `ChainError<mycrate::ErrorKind>`
|
||||
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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# Simple Chained String Errors
|
||||
|
||||
With relatively small changes and the help of the `context()` method of the `chainerror` crate
|
||||
the `&str` errors are now chained together.
|
||||
With relatively small changes and the help of the `cherr!` macro of the `chainerror` crate
|
||||
the `String` errors are now chained together.
|
||||
|
||||
Press the play button in the upper right corner and see the nice debug output.
|
||||
|
||||
|
@ -19,13 +19,14 @@ Press the play button in the upper right corner and see the nice debug output.
|
|||
{{#include ../examples/tutorial2.rs:13:15}}
|
||||
~~~
|
||||
|
||||
The function `context(newerror)` stores `olderror` as the source/cause of `newerror`
|
||||
along with the `Location` of the `context()` call and returns `Err(newerror)`.
|
||||
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`.
|
||||
|
||||
`?` then returns the inner error applying `.into()`, so that we
|
||||
`Err()?` then returns the inner error applying `.into()`, so that we
|
||||
again have a `Err(Box<Error + Send + Sync>)` as a result.
|
||||
|
||||
The `Debug` implementation of `chainerror::Error<T>` (which is returned by `context()`)
|
||||
The `Debug` implementation of `ChainError<T>` (which is returned by `cherr!()`)
|
||||
prints the `Debug` of `T` prefixed with the stored filename and line number.
|
||||
|
||||
`chainerror::Error<T>` in our case is `chainerror::Error<&str>`.
|
||||
`ChainError<T>` in our case is `ChainError<String>`.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Mapping Errors
|
||||
|
||||
Now let's get more rust idiomatic by using `.context()` directly on the previous `Result`.
|
||||
Now let's get more rust idiomatic by using `.map_err()`.
|
||||
|
||||
~~~rust
|
||||
{{#include ../examples/tutorial3.rs}}
|
||||
|
@ -14,13 +14,13 @@ If you compare the output to the previous example, you will see,
|
|||
that:
|
||||
|
||||
~~~
|
||||
Error: examples/tutorial2.rs:20:16: func1 error
|
||||
Error: src/main.rs:19: "func1 error"
|
||||
~~~
|
||||
|
||||
changed to just:
|
||||
|
||||
~~~
|
||||
examples/tutorial3.rs:17:13: func1 error
|
||||
src/main.rs:16: "func1 error"
|
||||
~~~
|
||||
|
||||
This is, because we caught the error of `func1()` in `main()` and print it out ourselves.
|
||||
|
|
|
@ -1,7 +1,12 @@
|
|||
# More information
|
||||
# Saving coding chars
|
||||
|
||||
To give more context to the error, you want to use `format!`
|
||||
to extend the information in the context string.
|
||||
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!()`.
|
||||
|
||||
~~~rust
|
||||
{{#include ../examples/tutorial4.rs}}
|
||||
|
|
|
@ -14,4 +14,5 @@ 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 use the `Display` backtrace, you have to use the alternative display format output `{:#}`.
|
||||
To enable the `Display` backtrace, you have to enable the feature `display-cause` for `chainerror`.
|
||||
|
|
@ -4,15 +4,15 @@
|
|||
|
||||
~~~rust,ignore
|
||||
fn is_chain<T: 'static + Display + Debug>(&self) -> bool
|
||||
fn downcast_chain_ref<T: 'static + Display + Debug>(&self) -> Option<&chainerror::Error<T>>
|
||||
fn downcast_chain_mut<T: 'static + Display + Debug>(&mut self) -> Option<&mut chainerror::Error<T>>
|
||||
fn downcast_chain_ref<T: 'static + Display + Debug>(&self) -> Option<&ChainError<T>>
|
||||
fn downcast_chain_mut<T: 'static + Display + Debug>(&mut self) -> Option<&mut ChainError<T>>
|
||||
fn root_cause(&self) -> Option<&(dyn Error + 'static)>
|
||||
fn find_cause<U: Error + 'static>(&self) -> Option<&U>
|
||||
fn find_chain_cause<U: Error + 'static>(&self) -> Option<&chainerror::Error<U>>
|
||||
fn find_chain_cause<U: Error + 'static>(&self) -> Option<&ChainError<U>>
|
||||
fn kind<'a>(&'a self) -> &'a T
|
||||
~~~
|
||||
|
||||
Using `downcast_chain_ref::<String>()` gives a `chainerror::Error<String>`, which can be used
|
||||
Using `downcast_chain_ref::<String>()` gives a `ChainError<String>`, which can be used
|
||||
to call `.find_cause::<io::Error>()`.
|
||||
|
||||
~~~rust,ignore
|
||||
|
|
|
@ -1,14 +1,14 @@
|
|||
# Finding an Error cause
|
||||
|
||||
To distinguish the errors occurring in various places, we can define named string errors with the
|
||||
To distinguish the errors occuring in various places, we can define named string errors with the
|
||||
"new type" pattern.
|
||||
|
||||
~~~rust,ignore
|
||||
chainerror::str_context!(Func2Error);
|
||||
chainerror::str_context!(Func1Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
derive_str_cherr!(Func1Error);
|
||||
~~~
|
||||
|
||||
Instead of `chainerror::Error<String>` we now have `struct Func1Error(String)` and `chainerror::Error<Func1Error>`.
|
||||
Instead of `ChainError<String>` we now have `struct Func1Error(String)` and `ChainError<Func1Error>`.
|
||||
|
||||
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::<chainerror::Error<Func2Error>>() {
|
||||
if let Some(f2err) = f1err.find_cause::<ChainError<Func2Error>>() {
|
||||
~~~
|
||||
hiding the `chainerror::Error<T>` implementation detail.
|
||||
hiding the `ChainError<T>` implementation detail.
|
||||
|
||||
~~~rust
|
||||
{{#include ../examples/tutorial8.rs}}
|
||||
|
|
|
@ -1,28 +1,24 @@
|
|||
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<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func4() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(format!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func3() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func4().annotate()?;
|
||||
let filename = "foo.txt";
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> chainerror::Result<(), Func2Error> {
|
||||
func3().context(Func2Error::new("func2 error: calling func3"))?;
|
||||
fn func2() -> ChainResult<(), Func2Error> {
|
||||
func3().map_err(mstrerr!(Func2Error, "func2 error: calling func3"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -31,8 +27,8 @@ enum Func1Error {
|
|||
IO(String),
|
||||
}
|
||||
|
||||
impl fmt::Display for Func1Error {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
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),
|
||||
|
@ -40,29 +36,21 @@ impl fmt::Display for Func1Error {
|
|||
}
|
||||
}
|
||||
|
||||
impl fmt::Debug for Func1Error {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
impl ::std::fmt::Debug for Func1Error {
|
||||
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
|
||||
write!(f, "{}", self)
|
||||
}
|
||||
}
|
||||
|
||||
fn func1() -> chainerror::Result<(), Func1Error> {
|
||||
func2().context(Func1Error::Func2)?;
|
||||
fn func1() -> ChainResult<(), Func1Error> {
|
||||
func2().map_err(|e| cherr!(e, Func1Error::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().context(Func1Error::IO(filename))?;
|
||||
do_some_io().map_err(|e| cherr!(e, 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) => {
|
||||
|
@ -78,5 +66,7 @@ fn main() {
|
|||
let ioerror = e.downcast_ref::<io::Error>().unwrap();
|
||||
eprintln!("\nThe root cause was: std::io::Error: {:#?}", ioerror);
|
||||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
#![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<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
|
|
@ -1,18 +1,18 @@
|
|||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -32,10 +32,10 @@ impl ::std::fmt::Display for Func1ErrorKind {
|
|||
}
|
||||
impl ::std::error::Error for Func1ErrorKind {}
|
||||
|
||||
fn func1() -> chainerror::Result<(), Func1ErrorKind> {
|
||||
func2().context(Func1ErrorKind::Func2)?;
|
||||
fn func1() -> ChainResult<(), Func1ErrorKind> {
|
||||
func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().context(Func1ErrorKind::IO(filename))?;
|
||||
do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -53,8 +53,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,18 +1,18 @@
|
|||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -38,10 +38,10 @@ impl ::std::fmt::Debug for Func1ErrorKind {
|
|||
|
||||
impl ::std::error::Error for Func1ErrorKind {}
|
||||
|
||||
fn func1() -> chainerror::Result<(), Func1ErrorKind> {
|
||||
func2().context(Func1ErrorKind::Func2)?;
|
||||
fn func1() -> ChainResult<(), Func1ErrorKind> {
|
||||
func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().context(Func1ErrorKind::IO(filename))?;
|
||||
do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -59,8 +59,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,18 +1,18 @@
|
|||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -38,10 +38,10 @@ impl ::std::fmt::Debug for Func1ErrorKind {
|
|||
|
||||
impl ::std::error::Error for Func1ErrorKind {}
|
||||
|
||||
fn func1() -> chainerror::Result<(), Func1ErrorKind> {
|
||||
func2().context(Func1ErrorKind::Func2)?;
|
||||
fn func1() -> ChainResult<(), Func1ErrorKind> {
|
||||
func2().map_err(|e| cherr!(e, Func1ErrorKind::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().context(Func1ErrorKind::IO(filename))?;
|
||||
do_some_io().map_err(|e| cherr!(e, Func1ErrorKind::IO(filename)))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -70,8 +70,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,9 +1,5 @@
|
|||
#![allow(clippy::single_match)]
|
||||
#![allow(clippy::redundant_pattern_matching)]
|
||||
|
||||
pub mod mycrate {
|
||||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::io;
|
||||
|
||||
fn do_some_io() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||
|
@ -11,11 +7,11 @@ pub mod mycrate {
|
|||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -25,7 +21,7 @@ pub mod mycrate {
|
|||
IO(String),
|
||||
}
|
||||
|
||||
chainerror::err_kind!(Error, ErrorKind);
|
||||
derive_err_kind!(Error, ErrorKind);
|
||||
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
|
@ -39,9 +35,9 @@ pub mod mycrate {
|
|||
}
|
||||
|
||||
pub fn func1() -> Result<()> {
|
||||
func2().context(ErrorKind::Func2)?;
|
||||
func2().map_err(|e| cherr!(e, ErrorKind::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().context(ErrorKind::IO(filename))?;
|
||||
do_some_io().map_err(|e| cherr!(e, ErrorKind::IO(filename)))?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
@ -76,8 +72,6 @@ fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,10 +1,7 @@
|
|||
#![allow(clippy::single_match)]
|
||||
#![allow(clippy::redundant_pattern_matching)]
|
||||
|
||||
pub mod mycrate {
|
||||
use std::error::Error as StdError;
|
||||
|
||||
use self::func2mod::{do_some_io, func2};
|
||||
use func2mod::{do_some_io, func2};
|
||||
|
||||
pub mod func2mod {
|
||||
use std::error::Error as StdError;
|
||||
|
@ -30,7 +27,7 @@ pub mod mycrate {
|
|||
}
|
||||
}
|
||||
|
||||
macro_rules! mcontext {
|
||||
macro_rules! mcherr {
|
||||
( $k:expr ) => {{
|
||||
|e| {
|
||||
Error(
|
||||
|
@ -95,7 +92,7 @@ pub mod mycrate {
|
|||
|
||||
pub fn func2() -> std::result::Result<(), Error> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().map_err(mcontext!(ErrorKind::IO(format!(
|
||||
do_some_io().map_err(mcherr!(ErrorKind::IO(format!(
|
||||
"Error reading '{}'",
|
||||
filename
|
||||
))))?;
|
||||
|
@ -118,7 +115,7 @@ pub mod mycrate {
|
|||
}
|
||||
}
|
||||
|
||||
macro_rules! mcontext {
|
||||
macro_rules! mcherr {
|
||||
( $k:expr ) => {{
|
||||
|e| {
|
||||
Error(
|
||||
|
@ -178,9 +175,9 @@ pub mod mycrate {
|
|||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
pub fn func1() -> Result<()> {
|
||||
func2().map_err(mcontext!(ErrorKind::Func2))?;
|
||||
func2().map_err(mcherr!(ErrorKind::Func2))?;
|
||||
let filename = String::from("bar.txt");
|
||||
do_some_io().map_err(mcontext!(ErrorKind::IO(filename)))?;
|
||||
do_some_io().map_err(mcherr!(ErrorKind::IO(filename)))?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
@ -215,8 +212,6 @@ fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,21 +1,19 @@
|
|||
#![allow(clippy::single_match)]
|
||||
#![allow(clippy::redundant_pattern_matching)]
|
||||
|
||||
pub mod mycrate {
|
||||
use chainerror::{Context as _, ErrorDown as _};
|
||||
|
||||
use std::io;
|
||||
|
||||
use chainerror::*;
|
||||
|
||||
fn do_some_io(_f: &str) -> std::result::Result<(), io::Error> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io(filename).context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io(filename)
|
||||
.map_err(|e| cherr!(e, Func2Error(format!("Error reading '{}'", filename))))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -27,7 +25,7 @@ pub mod mycrate {
|
|||
Unknown,
|
||||
}
|
||||
|
||||
chainerror::err_kind!(Error, ErrorKind);
|
||||
derive_err_kind!(Error, ErrorKind);
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
impl std::fmt::Display for ErrorKind {
|
||||
|
@ -84,19 +82,21 @@ pub mod mycrate {
|
|||
}
|
||||
|
||||
pub fn func1() -> Result<()> {
|
||||
func2().map_err(|e| ErrorKind::from(&e))?;
|
||||
func2().map_err(|e| cherr!(e, ErrorKind::from(&e)))?;
|
||||
|
||||
let filename = "bar.txt";
|
||||
|
||||
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))?;
|
||||
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))?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn super_func1() -> Result<()> {
|
||||
func1().map_context(|e| ErrorKind::from(e))?;
|
||||
func1().map_err(minto_cherr!(ErrorKind))?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
@ -133,8 +133,6 @@ fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
eprintln!("\nDebug Error:\n{:?}", e);
|
||||
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,7 +1,8 @@
|
|||
use chainerror::Context as _;
|
||||
use chainerror::*;
|
||||
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -10,14 +11,14 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = do_some_io() {
|
||||
Err(e).context("func2 error")?;
|
||||
Err(cherr!(e, "func2 error"))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = func2() {
|
||||
Err(e).context("func1 error")?;
|
||||
Err(cherr!(e, "func1 error"))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,7 +1,8 @@
|
|||
use chainerror::Context as _;
|
||||
use chainerror::*;
|
||||
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -9,19 +10,18 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
}
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
do_some_io().context("func2 error")?;
|
||||
do_some_io().map_err(|e| cherr!(e, "func2 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context("func1 error")?;
|
||||
func2().map_err(|e| cherr!(e, "func1 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = func1() {
|
||||
eprintln!("{:?}", e);
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -10,19 +10,18 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(format!("Error reading '{}'", filename))?;
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context("func1 error")?;
|
||||
func2().map_err(mstrerr!("func1 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = func1() {
|
||||
eprintln!("{:?}", e);
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -10,7 +10,7 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(format!("Error reading '{}'", filename))?;
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -18,7 +18,7 @@ fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
if let Err(e) = func2() {
|
||||
if let Some(s) = e.source() {
|
||||
eprintln!("func2 failed because of '{}'", s);
|
||||
Err(e).context("func1 error")?;
|
||||
Err(e).map_err(mstrerr!("func1 error"))?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
|
@ -27,7 +27,6 @@ fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = func1() {
|
||||
eprintln!("{}", e);
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,10 +1,7 @@
|
|||
#![allow(clippy::single_match)]
|
||||
#![allow(clippy::redundant_pattern_matching)]
|
||||
|
||||
use chainerror::Context as _;
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -13,12 +10,12 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(format!("Error reading '{}'", filename))?;
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context("func1 error")?;
|
||||
func2().map_err(mstrerr!("func1 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -38,7 +35,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
}
|
||||
s = c;
|
||||
}
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,10 +1,7 @@
|
|||
#![allow(clippy::single_match)]
|
||||
#![allow(clippy::redundant_pattern_matching)]
|
||||
|
||||
use chainerror::{Context as _, ErrorDown as _};
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
|
@ -13,12 +10,12 @@ fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(format!("Error reading '{}'", filename))?;
|
||||
do_some_io().map_err(mstrerr!("Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context("func1 error")?;
|
||||
func2().map_err(mstrerr!("func1 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -39,7 +36,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
eprintln!("The root cause was: std::io::Error: {:#?}", ioerror);
|
||||
}
|
||||
}
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
use chainerror::{Context as _, ErrorDown as _};
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func1Error);
|
||||
derive_str_cherr!(Func1Error);
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context(Func1Error::new("func1 error"))?;
|
||||
func2().map_err(mstrerr!(Func1Error, "func1 error"))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
|
@ -28,7 +28,7 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
if let Some(f1err) = e.downcast_chain_ref::<Func1Error>() {
|
||||
eprintln!("Func1Error: {}", f1err);
|
||||
|
||||
if let Some(f2err) = f1err.find_cause::<chainerror::Error<Func2Error>>() {
|
||||
if let Some(f2err) = f1err.find_cause::<ChainError<Func2Error>>() {
|
||||
eprintln!("Func2Error: {}", f2err);
|
||||
}
|
||||
|
||||
|
@ -36,7 +36,6 @@ fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
eprintln!("Debug Func2Error:\n{:?}", f2err);
|
||||
}
|
||||
}
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
@ -1,41 +1,40 @@
|
|||
use chainerror::{Context as _, ErrorDown};
|
||||
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::io;
|
||||
use std::result::Result;
|
||||
|
||||
fn do_some_io() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
Err(io::Error::from(io::ErrorKind::NotFound))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func2Error);
|
||||
derive_str_cherr!(Func2Error);
|
||||
|
||||
fn func2() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
let filename = "foo.txt";
|
||||
do_some_io().context(Func2Error(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func2Error, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
chainerror::str_context!(Func1ErrorFunc2);
|
||||
chainerror::str_context!(Func1ErrorIO);
|
||||
derive_str_cherr!(Func1ErrorFunc2);
|
||||
derive_str_cherr!(Func1ErrorIO);
|
||||
|
||||
fn func1() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
func2().context(Func1ErrorFunc2::new("func1 error calling func2"))?;
|
||||
func2().map_err(mstrerr!(Func1ErrorFunc2, "func1 error calling func2"))?;
|
||||
let filename = "bar.txt";
|
||||
do_some_io().context(Func1ErrorIO(format!("Error reading '{}'", filename)))?;
|
||||
do_some_io().map_err(mstrerr!(Func1ErrorIO, "Error reading '{}'", filename))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
if let Err(e) = func1() {
|
||||
if let Some(s) = e.downcast_ref::<chainerror::Error<Func1ErrorIO>>() {
|
||||
if let Some(s) = e.downcast_ref::<ChainError<Func1ErrorIO>>() {
|
||||
eprintln!("Func1ErrorIO:\n{:?}", s);
|
||||
}
|
||||
|
||||
if let Some(s) = e.downcast_chain_ref::<Func1ErrorFunc2>() {
|
||||
eprintln!("Func1ErrorFunc2:\n{:?}", s);
|
||||
}
|
||||
std::process::exit(1);
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
1260
src/lib.rs
1260
src/lib.rs
File diff suppressed because it is too large
Load diff
|
@ -1,33 +0,0 @@
|
|||
use chainerror::Context;
|
||||
|
||||
#[test]
|
||||
fn test_basic() {
|
||||
use std::path::PathBuf;
|
||||
type BoxedError = Box<dyn std::error::Error + Send + Sync>;
|
||||
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::<Vec<_>>();
|
||||
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!();
|
||||
}
|
||||
}
|
|
@ -1,54 +1,28 @@
|
|||
use chainerror::Context;
|
||||
use chainerror::*;
|
||||
use std::error::Error;
|
||||
use std::fmt::Write;
|
||||
use std::io;
|
||||
|
||||
#[test]
|
||||
fn test_iter() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
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 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 mut res = String::new();
|
||||
|
||||
for e in err.iter() {
|
||||
write!(res, "{}", e)?;
|
||||
write!(res, "{}", e.to_string())?;
|
||||
}
|
||||
assert_eq!(res, "654321entity not found");
|
||||
|
||||
let io_error: Option<&io::Error> = err
|
||||
.iter()
|
||||
.filter_map(<dyn Error>::downcast_ref::<io::Error>)
|
||||
.next();
|
||||
|
||||
assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_iter_alternate() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
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(<dyn Error>::downcast_ref::<io::Error>)
|
||||
.filter_map(Error::downcast_ref::<io::Error>)
|
||||
.next();
|
||||
|
||||
assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound);
|
||||
|
@ -58,14 +32,13 @@ fn test_iter_alternate() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
#[test]
|
||||
fn test_find_cause() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
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 = 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 io_error: Option<&io::Error> = err.find_cause::<io::Error>();
|
||||
|
||||
|
@ -76,17 +49,16 @@ fn test_find_cause() -> Result<(), Box<dyn Error + Send + Sync>> {
|
|||
|
||||
#[test]
|
||||
fn test_root_cause() -> Result<(), Box<dyn Error + Send + Sync>> {
|
||||
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 = 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: Option<&(dyn std::error::Error + 'static)> = err.root_cause();
|
||||
let io_error: Option<&io::Error> = err.and_then(<dyn Error>::downcast_ref::<io::Error>);
|
||||
let io_error: Option<&io::Error> = err.and_then(Error::downcast_ref::<io::Error>);
|
||||
|
||||
assert_eq!(io_error.unwrap().kind(), io::ErrorKind::NotFound);
|
||||
|
||||
|
|
Loading…
Reference in a new issue