GitHub - dtolnay/anyhow: Flexible concrete Error type built on std: :Error Skip to content Sign up Why GitHub? Features → Mobile → Actions → Codespaces → Packages → Security → Code review → Issues → Integrations → GitHub Sponsors → Customer stories→ Team Enterprise Explore Explore GitHub → Learn and contribute Topics → Collections → Trending → Learning Lab → Open source guides → Connect with others The ReadME Project → Events → Community forum → GitHub Education → GitHub Stars program → Marketplace Pricing Plans → Compare plans → Contact Sales → Education → In this repository All GitHub ↵ Jump to ↵ No suggested jump to results In this repository All GitHub ↵ Jump to ↵ In this user All GitHub ↵ Jump to ↵ In this repository All GitHub ↵ Jump to ↵ Sign in Sign up {{ message }} dtolnay / anyhow Notifications Star 2.1k Fork 66 Flexible concrete Error type built on std::error::Error View license 2.1k stars 66 forks Star Notifications Code Issues 16 Pull requests 3 Actions Security Insights More Code Issues Pull requests Actions Security Insights master Switch branches/tags Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 44 tags Code Clone HTTPS GitHub CLI Use Git or checkout with SVN using the web URL. Work fast with our official CLI. Learn more. Open with GitHub Desktop Download ZIP Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching Xcode If nothing happens, download Xcode and try again. Go back Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit dtolnay Ignore unhelpful Clippy lint in build script … b45d649 Aug 14, 2021 Ignore unhelpful Clippy lint in build script b45d649 Git stats 393 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github/workflows Add additional builds on 1.50 and 1.51 validating addr_of codepath Mar 25, 2021 src Release 1.0.43 Aug 14, 2021 tests Resolve default_trait_access clippy lint in PR 158 Jul 3, 2021 .clippy.toml Inform clippy of supported compiler version in clippy.toml Dec 30, 2020 .gitignore Initial commit Oct 5, 2019 Cargo.toml Release 1.0.43 Aug 14, 2021 LICENSE-APACHE Dual mit OR apache license Oct 5, 2019 LICENSE-MIT Dual mit OR apache license Oct 5, 2019 README.md Update mascot Mar 20, 2021 build.rs Ignore unhelpful Clippy lint in build script Aug 14, 2021 View code Anyhow ¯\_(°ペ)_/¯ Details No-std support Comparison to failure Comparison to thiserror License README.md Anyhow ¯\_(°ペ)_/¯ This library provides anyhow::Error, a trait object based error type for easy idiomatic error handling in Rust applications. [dependencies] anyhow = "1.0" Compiler support: requires rustc 1.34+ Details Use Result, or equivalently anyhow::Result, as the return type of any fallible function. Within the function, use ? to easily propagate any error that implements the std::error::Error trait. use anyhow::Result; fn get_cluster_info() -> Result { let config = std::fs::read_to_string("cluster.json")?; let map: ClusterMap = serde_json::from_str(&config)?; Ok(map) } Attach context to help the person troubleshooting the error understand where things went wrong. A low-level error like "No such file or directory" can be annoying to debug without more context about what higher level step the application was in the middle of. use anyhow::{Context, Result}; fn main() -> Result<()> { ... it.detach().context("Failed to detach the important thing")?; let content = std::fs::read(path) .with_context(|| format!("Failed to read instrs from {}", path))?; ... } Error: Failed to read instrs from ./path/to/instrs.json Caused by: No such file or directory (os error 2) Downcasting is supported and can be by value, by shared reference, or by mutable reference as needed. // If the error was caused by redaction, then return a // tombstone instead of the content. match root_cause.downcast_ref::() { Some(DataStoreError::Censored(_)) => Ok(Poll::Ready(REDACTED_CONTENT)), None => Err(error), } If using the nightly channel, a backtrace is captured and printed with the error if the underlying error type does not already provide its own. In order to see backtraces, they must be enabled through the environment variables described in std::backtrace: If you want panics and errors to both have backtraces, set RUST_BACKTRACE=1; If you want only errors to have backtraces, set RUST_LIB_BACKTRACE=1; If you want only panics to have backtraces, set RUST_BACKTRACE=1 and RUST_LIB_BACKTRACE=0. The tracking issue for this feature is rust-lang/rust#53487. Anyhow works with any error type that has an impl of std::error::Error, including ones defined in your crate. We do not bundle a derive(Error) macro but you can write the impls yourself or use a standalone macro like thiserror. use thiserror::Error; #[derive(Error, Debug)] pub enum FormatError { #[error("Invalid header (expected {expected:?}, got {found:?})")] InvalidHeader { expected: String, found: String, }, #[error("Missing attribute: {0}")] MissingAttribute(String), } One-off error messages can be constructed using the anyhow! macro, which supports string interpolation and produces an anyhow::Error. return Err(anyhow!("Missing attribute: {}", missing)); A bail! macro is provided as a shorthand for the same early return. bail!("Missing attribute: {}", missing); No-std support In no_std mode, the same API is almost all available and works the same way. To depend on Anyhow in no_std mode, disable our default enabled "std" feature in Cargo.toml. A global allocator is required. [dependencies] anyhow = { version = "1.0", default-features = false } Since the ?-based error conversions would normally rely on the std::error::Error trait which is only available through std, no_std mode will require an explicit .map_err(Error::msg) when working with a non-Anyhow error type inside a function that returns Anyhow's error type. Comparison to failure The anyhow::Error type works something like failure::Error, but unlike failure ours is built around the standard library's std::error::Error trait rather than a separate trait failure::Fail. The standard library has adopted the necessary improvements for this to be possible as part of RFC 2504. Comparison to thiserror Use Anyhow if you don't care what error type your functions return, you just want it to be easy. This is common in application code. Use thiserror if you are a library that wants to design your own dedicated error type(s) so that on failures the caller gets exactly the information that you choose. License Licensed under either of Apache License, Version 2.0 or MIT license at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. About Flexible concrete Error type built on std::error::Error Resources Readme License View license Releases 44 1.0.43 Latest Aug 14, 2021 + 43 releases Contributors 16 + 5 contributors Languages Rust 100.0% © 2021 GitHub, Inc. Terms Privacy Security Status Docs Contact GitHub Pricing API Training Blog About You can’t perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.