Struct oofs::Oof

pub struct Oof { /* private fields */ }

Error type for oofs.

Oof implements std::error::Error.

Implementations

impl Oof

pub fn custom(message: String) -> Oof

Create a new Oof with custom context message.

You can also use oof!(…).

pub fn tags(&self) -> impl Iterator<Item = &TypeId>

Lists all tags as TypeId.

You can also use oof!(…).

pub fn tagged<T: 'static>(&self) -> bool

Check if this Oof is tagged as given type.

This method only checks one level deep. To check all nested errors, use Oof::tagged_nested.

pub fn tagged_nested<T: 'static>(&self) -> bool

Check if this Oof is tagged in all nested errors.

This method checks all levels.

pub fn tagged_nested_rev<T: 'static>(&self) -> bool

Check if this Oof is tagged in all nested errors in reverse order.

This method checks all levels.

pub fn tag<T: 'static>(self) -> Self

Tag Oof with type and return Self.

pub fn tag_if<Tag, F>(self, f: F) -> Selfwhere
    Tag: 'static,
    F: FnOnce(&Box<dyn Send + Sync + Error + 'static>) -> bool,

Tag Oof if given closure returns true and return Self.

pub fn attach<D: Debug>(self, debuggable: D) -> Self

Attach any value that implements std::fmt::Debug.

This attached value will be listed as attachments in the displayed error.

Ex)

use oofs::{oof, oofs};

let x = 123u8;

return oof!("custom error")
    .attach(x)
    .attach("some attachment")
    .into_res();

Above example will output:

custom error at `oofs/tests/basic.rs:9:13`

Attachments:
   0: 123
   1: "some attachment"

pub fn attach_lazy<D: ToString, F: FnOnce() -> D>(self, f: F) -> Self

Lazily load and attach any value that implements ToString.

This attached value will be listed as attachments in the displayed error.

Ex)

use oofs::{oof, oofs};


return oof!("custom error")
    .attach_lazy(|| "some attachment")
    .into_res();

Above example will output:

custom error at `oofs/tests/basic.rs:9:13`

Attachments:
   0: "some attachment"

pub fn into_res<T, E>(self) -> Result<T, E>where
    E: From<Self>,

Wraps Oof in Result::Err(_).

Use it to easily return an Oof instead of manually wrapping it in Err(_).

Trait Implementations

impl Debug for Oof

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

Formats the value using the given formatter.

impl Display for Oof

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

Formats the value using the given formatter.

impl Error for Oof

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

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 self, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.