Struct TwirpError

pub struct TwirpError { /* private fields */ }

A Twirp error

It is composed of three elements:

• An error code that is member of a fixed list TwirpErrorCode
• A human error message describing the error as a string
• A set of “meta” key-value pairs as strings holding arbitrary metadata describing the error.

let error = TwirpError::not_found("Object foo not found").with_meta("id", "foo");
assert_eq!(error.code(), TwirpErrorCode::NotFound);
assert_eq!(error.message(), "Object foo not found");
assert_eq!(error.meta("id"), Some("foo"));

Implementations

impl TwirpError

pub fn code(&self) -> TwirpErrorCode

pub fn message(&self) -> &str

pub fn into_message(self) -> String

pub fn meta(&self, key: &str) -> Option<&str>

Get an associated metadata

pub fn meta_iter(&self) -> impl Iterator<Item = (&str, &str)>

Get all associated metadata

pub fn new(code: TwirpErrorCode, msg: impl Into<String>) -> Self

pub fn wrap( code: TwirpErrorCode, msg: impl Into<String>, e: impl Error + Send + Sync + 'static, ) -> Self

pub fn with_meta(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an associated metadata

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

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

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

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

pub fn invalid_argument( argument: impl Into<String>, msg: impl Into<String>, ) -> Self

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

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

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

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

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

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

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

pub fn required_argument(argument: &str) -> Self

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

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

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

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

Trait Implementations

impl Clone for TwirpError

fn clone(&self) -> TwirpError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TwirpError

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

Formats the value using the given formatter.

impl Display for TwirpError

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

Formats the value using the given formatter.

impl Error for TwirpError

fn source(&self) -> Option<&(dyn Error + '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 PartialEq for TwirpError

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TwirpError