Crate cew

A personal utility crate.

Adds reexports of color_eyre, piping traits (Pipe, Inspect, Lay), a block_on implementation for futures, reexports thiserror, and reexports tracing + tracing_subscriber (as tracing_utils::subscriber) with a prelude and quick init function.

Run cew::init() to initialize color_eyre

cew::R is short for color_eyre::Result

cew::U is short for color_eyre::Result<()>

cew::e!(..) is short for color_eyre::eyre::eyre!(..)

cew::me!(..) is short for Err(color_eyre::eyre::eyre!(..))

The Pipe, Inspect, and Lay traits provide functions to reduce the amount of stacked parenthesis in long method chains, like the tap crate.

The tracing_subscriber quick init should be overriden with a custom impl if needed, but it gets you started quickly.

Usage:

use cew::prelude::*;

fn main() -> cew::U {
    cew::init()?;
    // turbofish is needed here, as the type parameters cannot be inferred.
    cew::tracing::init_filtered_w_env::<String, cew::tracing::Layer>(
      cew::tracing::fmt_layer().without_time(),
      cew::tracing::LevelFilter::INFO,
      []
    )?;

    info!("Traced").

    cew::me!("Error");
}

Re-exports

pub use thiserror;

Modules

prelude

tracing

Macros

e

Construct an ad-hoc error from a string.

me

Construct an ad-hoc color_eyre::Result::Err from a string

Structs

E

The core error reporting type of the library, a wrapper around a dynamic error reporting type.

Traits

BlockOn

Block on a future.

EExt

A helper trait for attaching informational sections to error reports to be displayed after the chain of errors

EExt2

Extension trait for constructing sections with commonly used formats

Inspect

Run a function on a shared reference to self, but return self. Use the fallible/nullable functions [inspect_try] and [inspect_maybe] if you want to propagate errors.

Lay

Run a function that mutates self, returning self. Use the fallible/nullable functions [lay_try] and [lay_maybe] if you want to propagate errors.

Pipe

Apply a transformation to self, returning the result.

Functions

init

Initializes color_eyre

Type Aliases

R

type alias for Result<T, Report>

U

type alias for Result<(), Report>