Module error

Re-export risingwave_error for easy access.

Developer should add new utilities to risingwave_error crate and only re-export them here.

Modules

anyhow

common

Commonly used error types.

macros

thiserror_ext

Useful extension utilities for thiserror.

tonic

Macros

bail

Return early with an error, in any type that can be converted from an anyhow::Error.

bail_no_function

Constructs a NoFunction and bails out.

bail_not_implemented

Constructs a NotImplemented and bails out.

def_anyhow_newtype

Define a newtype wrapper around anyhow::Error.

def_anyhow_variant

Define a newtype + it’s variant in the specified type. This is useful when you want to define a new error type, but also want to define a variant for it in another enum.

ensure

Util macro for generating error when condition check failed.

ensure_eq

Util macro to generate error when the two arguments are not equal.

must_match

Match an enum variant and return the internal value.

no_function

Constructs a NoFunction.

not_implemented

Constructs a NotImplemented.

try_match_expand

Try to match an enum variant and return the internal value.

Structs

NoFunction

NotImplemented

Report

A wrapper around an error that provides a cleaned up error trace for display and debug formatting.

TrackingIssue

Traits

AsDyn

Extension trait for Error that casts the error to a trait object.

AsReport

Extension trait for Error that provides a Report which formats the error and its sources in a cleaned-up way.

Type Aliases

BoxedError

A boxed error type that is Send, Sync, and 'static.

Derive Macros

Arc

Generates a new type that wraps the original error type in an Arc.

Box

Generates a new type that wraps the original error type in a [struct@Box].

Construct

Generates constructor functions for different variants of the error type.

ContextInto

Generates extension traits for converting the external error type into the the provided one, with extra context.

Macro

Generates macros for different variants of the error type to construct it or directly bail out.

ReportDebug

Generates the [Debug] implementation that delegates to the Report of an error.