mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-05-18 08:28:38 +02:00
* Update error-contexts.md Adding more speaker notes about `anyhow`. * Add markup Co-authored-by: Martin Geisler <martin@geisler.net>
1.4 KiB
1.4 KiB
Adding Context to Errors
The widely used anyhow crate can help you add contextual information to your errors and allows you to have fewer custom error types:
use std::{fs, io};
use std::io::Read;
use thiserror::Error;
use anyhow::{Context, Result};
#[derive(Error, Debug)]
enum ReadUsernameError {
#[error("Found no username in {0}")]
EmptyUsername(String),
}
fn read_username(path: &str) -> Result<String> {
let mut username = String::with_capacity(100);
fs::File::open(path)
.context(format!("Failed to open {path}"))?
.read_to_string(&mut username)
.context("Failed to read")?;
if username.is_empty() {
return Err(ReadUsernameError::EmptyUsername(String::from(path)))?;
}
Ok(username)
}
fn main() {
//fs::write("config.dat", "").unwrap();
match read_username("config.dat") {
Ok(username) => println!("Username: {username}"),
Err(err) => println!("Error: {err:?}"),
}
}
anyhow::Result<T>
is generic and it can hold anyError
implementation without changing the type signature.- Actual error type inside of it can be extracted for examination if necessary.
- Functionality provided by
anyhow::Result<T>
may be familiar to Go developers, as it provides similar usage patterns and ergonomics of(T, error)
from Go.