1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
use std::{error::Error as StdError, fmt};
use crate::{Chain, CliError, Error, ExitCode};
mod chain;
mod wrap;
impl Error {
/// Create a new error object from any error type.
///
/// The error type must be threadsafe and `'static`, so that the `Error`
/// will be as well.
pub fn new<E>(error: E) -> Self
where
E: StdError + Send + Sync + 'static,
{
Self {
inner: error.into(),
help: None,
}
}
/// Convert an [`anyhow::Error`] into an error object.
///
/// Due to the generic implmentation of [`From`] for [`Error`]: we cannot
/// add a `From<anyhow::Error>` impl. Use this instead.
#[inline]
pub fn from_anyhow(error: anyhow::Error) -> Self {
Self {
inner: error,
help: None,
}
}
/// Wrap the error value with additional context.
///
/// For attaching context to a `Result` as it is propagated, the
/// [`ErrorWrap`](crate::ErrorWrap) extension trait may be more convenient than this function.
///
/// The primary reason to use `error.warp(...)` instead of
/// `result.warp(...)` via the `ErrorWrap` trait would be if the context
/// needs to depend on some data held by the underlying error:
///
/// ```
/// # use std::fmt::{self, Debug, Display};
/// #
/// # type T = ();
/// #
/// # impl std::error::Error for ParseError {}
/// # impl Debug for ParseError {
/// # fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
/// # unimplemented!()
/// # }
/// # }
/// # impl Display for ParseError {
/// # fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
/// # unimplemented!()
/// # }
/// # }
/// #
/// use narrate::Result;
/// use std::fs::File;
/// use std::path::Path;
///
/// struct ParseError {
/// line: usize,
/// column: usize,
/// }
///
/// fn parse_impl(file: File) -> Result<T, ParseError> {
/// # /*
/// ...
/// # */
/// # unimplemented!()
/// }
///
/// pub fn parse(path: impl AsRef<Path>) -> Result<T> {
/// let file = File::open(&path)?;
/// parse_impl(file).map_err(|error| {
/// let context = format!(
/// "only the first {} lines of {} are valid",
/// error.line, path.as_ref().display(),
/// );
/// narrate::Error::new(error).wrap(context)
/// })
/// }
/// ```
pub fn wrap<C>(self, context: C) -> Self
where
C: fmt::Display + Send + Sync + 'static,
{
Self {
inner: self.inner.context(context),
help: self.help,
}
}
/// Returns true if `E` is the type held by this error object.
///
/// For wrapped errors, this method returns true if `E` matches the
/// type of the context `C` **or** the type of the error on which the
/// context has been attached.
pub fn is<E>(&self) -> bool
where
E: fmt::Display + fmt::Debug + Send + Sync + 'static,
{
self.downcast_ref::<E>().is_some()
}
/// Attempt to downcast the error object to a concrete type.
pub fn downcast<E>(self) -> Result<E, anyhow::Error>
where
E: fmt::Display + fmt::Debug + Send + Sync + 'static,
{
self.inner.downcast()
}
/// Downcast this error object by reference.
///
/// # Example
///
/// ```
/// # use narrate::error_from;
/// # use std::fmt::{self, Display};
/// # use std::task::Poll;
/// #
/// # #[derive(Debug)]
/// # enum DataStoreError {
/// # Censored(()),
/// # }
/// #
/// # impl Display for DataStoreError {
/// # fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
/// # unimplemented!()
/// # }
/// # }
/// #
/// # impl std::error::Error for DataStoreError {}
/// #
/// # const REDACTED_CONTENT: () = ();
/// #
/// # let error = error_from!("...");
/// # let root_cause = &error;
/// #
/// # let ret =
/// // If the error was caused by redaction, then return a tombstone instead
/// // of the content.
/// match root_cause.downcast_ref::<DataStoreError>() {
/// Some(DataStoreError::Censored(_)) => Ok(Poll::Ready(REDACTED_CONTENT)),
/// None => Err(error),
/// }
/// # ;
/// ```
pub fn downcast_ref<E>(&self) -> Option<&E>
where
E: fmt::Display + fmt::Debug + Send + Sync + 'static,
{
self.inner.downcast_ref()
}
/// Downcast this error object by mutable reference.
pub fn downcast_mut<E>(&mut self) -> Option<&mut E>
where
E: fmt::Display + fmt::Debug + Send + Sync + 'static,
{
self.inner.downcast_mut()
}
/// An iterator of the chain of source errors contained by this Error.
///
/// This iterator will visit every error in the cause chain of this error
/// object, beginning with the error that this error object was created
/// from.
///
/// # Example
///
/// ```
/// use narrate::Error;
/// use std::io;
///
/// pub fn underlying_io_error_kind(error: &Error) -> Option<io::ErrorKind> {
/// for cause in error.chain() {
/// if let Some(io_error) = cause.downcast_ref::<io::Error>() {
/// return Some(io_error.kind());
/// }
/// }
/// None
/// }
/// ```
pub fn chain(&self) -> Chain {
self.inner.chain().into()
}
/// The lowest level cause of this error — this error's cause's
/// cause's cause etc.
///
/// The root cause is the last error in the iterator produced by
/// [`chain()`][Error::chain].
pub fn route_cause(&self) -> &(dyn StdError + 'static) {
self.inner.root_cause()
}
/// Get a reference to this error's help message
#[inline]
pub fn help(&self) -> Option<&str> {
self.help.as_ref().map(AsRef::as_ref)
}
/// Set this error's help message to an owned [`String`]
#[inline]
pub fn set_help_owned(&mut self, msg: String) {
self.help = Some(HelpMsg::Owned(msg));
}
/// Set this error's help message to a static `&str`
#[inline]
pub fn set_help(&mut self, msg: &'static str) {
self.help = Some(HelpMsg::Static(msg));
}
}
impl ExitCode for Error {
fn exit_code(&self) -> i32 {
self.inner.exit_code()
}
}
impl<E> From<E> for Error
where
E: StdError + Send + Sync + 'static,
{
fn from(err: E) -> Self {
Self {
inner: err.into(),
help: None,
}
}
}
#[derive(Debug)]
pub(crate) enum HelpMsg {
Owned(String),
Static(&'static str),
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.help {
None => self.inner.fmt(f),
Some(ref help) => write!(f, "{}\n\n{}", self.inner, help),
}
}
}
impl AsRef<str> for HelpMsg {
fn as_ref(&self) -> &str {
match self {
HelpMsg::Owned(ref s) => s,
HelpMsg::Static(s) => s,
}
}
}
impl fmt::Display for HelpMsg {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
HelpMsg::Owned(help) => help.fmt(f),
HelpMsg::Static(help) => help.fmt(f),
}
}
}
impl<'a> PartialEq<&'a str> for HelpMsg {
fn eq(&self, r: &&'a str) -> bool {
match self {
Self::Owned(l) => l == r,
Self::Static(l) => l == r,
}
}
}
impl ExitCode for anyhow::Error {
fn exit_code(&self) -> i32 {
if let Some(err) = self.downcast_ref::<CliError>() {
err.exit_code()
} else if let Some(err) = self.downcast_ref::<Error>() {
err.exit_code()
} else {
exitcode::SOFTWARE
}
}
}
impl From<Error> for anyhow::Error {
fn from(err: Error) -> Self {
err.inner
}
}