Struct Error

Source
pub struct Error { /* private fields */ }
Expand description

Error is the error struct returned by all opendal 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: opendal::error::Error::new
             at ./src/error.rs:197:24
   1: opendal::error::tests::generate_error
             at ./src/error.rs:241:9
   2: opendal::error::tests::test_error_debug_with_backtrace::{{closure}}
             at ./src/error.rs:305:41
   ...
  • For conventional struct-style Debug representation, like format!("{err:#?}"):
Error {
    kind: Unexpected,
    message: "something wrong happened",
    status: Permanent,
    operation: "Read",
    context: [
        (
            "path",
            "/path/to/file",
        ),
        (
            "called",
            "send_async",
        ),
    ],
    source: Some(
        "networking error",
    ),
}

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_operation(self, operation: impl Into<&'static str>) -> Self

Update error’s operation.

§Notes

If the error already carries an operation, we will push a new context (called, operation).

Source

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

Add more context in error.

Source

pub fn set_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 map<F>(self, f: F) -> Self
where F: FnOnce(Self) -> Self,

Operate on error with map.

Source

pub fn set_permanent(self) -> Self

Set permanent status for error.

Source

pub fn set_temporary(self) -> Self

Set temporary status for error.

By set temporary, we indicate this error is retryable.

Source

pub fn set_persistent(self) -> Self

Set persistent status for error.

By setting persistent, we indicate the retry should be stopped.

Source

pub fn kind(&self) -> ErrorKind

Return error’s kind.

Source

pub fn is_temporary(&self) -> bool

Check if this error is temporary.

Source

pub fn backtrace(&self) -> Option<&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 opendal::Error’s backtrace in the standard way, you can implement a newtype like this:

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

#[derive(::std::fmt::Debug)]
pub struct OpendalError(opendal::Error);

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

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

    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 opendal::Error type.

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

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()
1.0.0 · Source§

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§

impl From<Error> for Error

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ServiceExt for T

Source§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
Source§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
Source§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
Source§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
Source§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> MaybeSend for T
where T: Send,