Enum Error 

pub enum Error {
    Context {
        msg: String,
        source: Box<SError>,
    },
    HostLang(Box<dyn HostError>),
    Client {
        msg: String,
        bt: Backtrace,
    },
    Internal(Error),
}

The workspace error. Each variant marks where a failure originated.

Variants

Context

A message wrapping an inner error, forming a context trail.

Fields

msg: String

source: Box<SError>

HostLang(Box<dyn HostError>)

An error surfaced from an embedding host language (e.g. Python).

Client

A caller mistake — bad input or a failed precondition. Carries a backtrace and renders as Invalid Request: ...

Fields

msg: String

bt: Backtrace

Internal(Error)

An internal fault, holding an anyhow::Error for flexible context.

Implementations

impl Error

pub fn host(e: impl HostError) -> Self

Wraps a host-language error as Error::HostLang.

pub fn client(msg: impl Into<String>) -> Self

Builds a Error::Client from a message, capturing a backtrace.

pub fn internal(e: impl Into<Error>) -> Self

Wraps any Into<anyhow::Error> as Error::Internal.

pub fn internal_msg(msg: impl Into<String>) -> Self

Builds an Error::Internal straight from a message.

pub fn backtrace(&self) -> Option<&Backtrace>

Returns the backtrace, if this error (or the error it wraps) captured one. Host-language errors have none.

pub fn without_contexts(&self) -> &Error

Peels off any Context layers to reach the underlying error.

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

Returns this error’s source, if any, for chain traversal.

pub fn context<C: Into<String>>(self, context: C) -> Self

Wraps this error in a Context layer carrying context.

pub fn with_context<C: Into<String>, F: FnOnce() -> C>(self, f: F) -> Self

Like context, but builds the message lazily — f runs only on the error path.

pub fn std_error(self) -> SError

Wraps this error in an SError so it satisfies a 'static std::error::Error bound.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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

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

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.

impl From<ApiError> for Error

fn from(e: ApiError) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for Error

fn from(e: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(err: Error) -> ApiError

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SharedError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(e: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseBoolError> for Error

fn from(e: ParseBoolError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(e: ParseIntError) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for Error

fn from(e: PoisonError<T>) -> Self

Converts to this type from the input type.

impl From<ResidualError> for Error

fn from(e: ResidualError) -> Self

Converts to this type from the input type.