Struct Error

Source

pub struct Error { /* private fields */ }

Expand description

Error is the error struct returned by all iceberg functions.

§Display

Error can be displayed in two ways:

Via Display: like err.to_string() or format!("{err}")

Error will be printed in a single line:

Unexpected, context: { path: /path/to/file, called: send_async } => something wrong happened, source: networking error"

Via Debug: like format!("{err:?}")

Error will be printed in multi lines with more details and backtraces (if captured):

Unexpected => something wrong happened

Context:
   path: /path/to/file
   called: send_async

Source: networking error

Backtrace:
   0: iceberg::error::Error::new
             at ./src/error.rs:197:24
   1: iceberg::error::tests::generate_error
             at ./src/error.rs:241:9
   2: iceberg::error::tests::test_error_debug_with_backtrace::{{closure}}
             at ./src/error.rs:305:41
   ...

Implementations§

Source §

impl Error

Source

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

Create a new Error with error kind and message.

Source

pub fn with_retryable(self, retryable: bool) -> Self

Set retryable of the error.

Source

pub fn with_context(self, key: &'static str, value: impl Into<String>) -> Self

Add more context in error.

Source

pub fn with_source(self, src: impl Into<Error>) -> Self

Set source for error.

§Notes

If the source has been set, we will raise a panic here.

Source

pub fn backtrace(&self) -> &Backtrace

Return error’s backtrace.

Note: the standard way of exposing backtrace is the unstable feature error_generic_member_access. We don’t provide it as it requires nightly rust.

If you just want to print error with backtrace, use Debug, like format!("{err:?}").

If you use nightly rust, and want to access iceberg::Error’s backtrace in the standard way, you can implement a new type like this:

// assume you already have `#![feature(error_generic_member_access)]` on the top of your crate

#[derive(::std::fmt::Debug)]
pub struct IcebergError(iceberg::Error);

impl std::fmt::Display for IcebergError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl std::error::Error for IcebergError {
    fn provide<'a>(&'a self, request: &mut std::error::Request<'a>) {
        request.provide_ref::<std::backtrace::Backtrace>(self.0.backtrace());
    }

    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.0.source()
    }
}

Additionally, you can add a clippy lint to prevent usage of the original iceberg::Error type.

disallowed-types = [
    { path = "iceberg::Error", reason = "Please use `my_crate::IcebergError` instead." },
]

Source

pub fn kind(&self) -> ErrorKind

Return error’s kind.

Users can use this method to check error’s kind and take actions.

Source

pub fn retryable(&self) -> bool

Return error’s retryable status

Source

pub fn message(&self) -> &str

Return error’s message.

Trait Implementations§

Source §

impl Debug for Error

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl Display for Error

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Source §

impl Error for Error

Source §

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

Source §

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports. Read more

Source §