diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:22:09 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:22:09 +0000 |
commit | 43a97878ce14b72f0981164f87f2e35e14151312 (patch) | |
tree | 620249daf56c0258faa40cbdcf9cfba06de2a846 /third_party/rust/error-support/src/lib.rs | |
parent | Initial commit. (diff) | |
download | firefox-upstream.tar.xz firefox-upstream.zip |
Adding upstream version 110.0.1.upstream/110.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/error-support/src/lib.rs')
-rw-r--r-- | third_party/rust/error-support/src/lib.rs | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/third_party/rust/error-support/src/lib.rs b/third_party/rust/error-support/src/lib.rs new file mode 100644 index 0000000000..7ea91caa17 --- /dev/null +++ b/third_party/rust/error-support/src/lib.rs @@ -0,0 +1,160 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +mod macros; + +#[cfg(feature = "backtrace")] +/// Re-export of the `backtrace` crate for use in macros and +/// to ensure the needed version is kept in sync in dependents. +pub use backtrace; + +#[cfg(not(feature = "backtrace"))] +/// A compatibility shim for `backtrace`. +pub mod backtrace { + use std::fmt; + + pub struct Backtrace; + + impl fmt::Debug for Backtrace { + #[cold] + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + write!(f, "Not available") + } + } +} + +mod redact; +pub use redact::*; + +mod reporting; +pub use reporting::{ + report_breadcrumb, report_error_to_app, set_application_error_reporter, + unset_application_error_reporter, ApplicationErrorReporter, +}; + +mod handling; +pub use handling::{convert_log_report_error, ErrorHandling, ErrorReporting, GetErrorHandling}; + +/// XXX - Most of this is now considered deprecated - only FxA uses it, and +/// should be replaced with the facilities in the `handling` module. + +/// Define a wrapper around the the provided ErrorKind type. +/// See also `define_error` which is more likely to be what you want. +#[macro_export] +macro_rules! define_error_wrapper { + ($Kind:ty) => { + pub type Result<T, E = Error> = std::result::Result<T, E>; + struct ErrorData { + kind: $Kind, + backtrace: Option<std::sync::Mutex<$crate::backtrace::Backtrace>>, + } + + impl ErrorData { + #[cold] + fn new(kind: $Kind) -> Self { + ErrorData { + kind, + #[cfg(feature = "backtrace")] + backtrace: Some(std::sync::Mutex::new( + $crate::backtrace::Backtrace::new_unresolved(), + )), + #[cfg(not(feature = "backtrace"))] + backtrace: None, + } + } + + #[cfg(feature = "backtrace")] + #[cold] + fn get_backtrace(&self) -> Option<&std::sync::Mutex<$crate::backtrace::Backtrace>> { + self.backtrace.as_ref().map(|mutex| { + mutex.lock().unwrap().resolve(); + mutex + }) + } + + #[cfg(not(feature = "backtrace"))] + #[cold] + fn get_backtrace(&self) -> Option<&std::sync::Mutex<$crate::backtrace::Backtrace>> { + None + } + } + + impl std::fmt::Debug for ErrorData { + #[cfg(feature = "backtrace")] + #[cold] + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + let mut bt = self.backtrace.unwrap().lock().unwrap(); + bt.resolve(); + write!(f, "{:?}\n\n{}", bt, self.kind) + } + + #[cfg(not(feature = "backtrace"))] + #[cold] + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + write!(f, "{}", self.kind) + } + } + + #[derive(Debug, thiserror::Error)] + pub struct Error(Box<ErrorData>); + impl Error { + #[cold] + pub fn kind(&self) -> &$Kind { + &self.0.kind + } + + #[cold] + pub fn backtrace(&self) -> Option<&std::sync::Mutex<$crate::backtrace::Backtrace>> { + self.0.get_backtrace() + } + } + + impl std::fmt::Display for Error { + #[cold] + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + std::fmt::Display::fmt(self.kind(), f) + } + } + + impl From<$Kind> for Error { + // Cold to optimize in favor of non-error cases. + #[cold] + fn from(ctx: $Kind) -> Error { + Error(Box::new(ErrorData::new(ctx))) + } + } + }; +} + +/// Define a set of conversions from external error types into the provided +/// error kind. Use `define_error` to do this at the same time as +/// `define_error_wrapper`. +#[macro_export] +macro_rules! define_error_conversions { + ($Kind:ident { $(($variant:ident, $type:ty)),* $(,)? }) => ($( + impl From<$type> for Error { + // Cold to optimize in favor of non-error cases. + #[cold] + fn from(e: $type) -> Self { + Error::from($Kind::$variant(e)) + } + } + )*); +} + +/// All the error boilerplate (okay, with a couple exceptions in some cases) in +/// one place. +#[macro_export] +macro_rules! define_error { + ($Kind:ident { $(($variant:ident, $type:ty)),* $(,)? }) => { + $crate::define_error_wrapper!($Kind); + $crate::define_error_conversions! { + $Kind { + $(($variant, $type)),* + } + } + }; +} + +uniffi_macros::include_scaffolding!("errorsupport"); |