Struct TwirpError

pub struct TwirpError { /* private fields */ }

Expand description

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>) -> TwirpError

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

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

Set an associated metadata

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

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

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

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

pub fn invalid_argument(msg: impl Into<String>) -> TwirpError

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

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

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

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

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

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

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

pub fn required_argument(msg: impl Into<String>) -> TwirpError

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

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

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

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

Trait Implementations§

impl Clone for TwirpError

fn clone(&self) -> TwirpError

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for TwirpError

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for TwirpError

fn deserialize<D>( deserializer: D, ) -> Result<TwirpError, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for TwirpError

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

Formats the value using the given formatter. Read more

impl Error for TwirpError

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

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

1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

1.0.0 · Source§

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. Read more

impl<B> From<Response<B>> for TwirpError
where B: AsRef<[u8]>,

fn from(response: Response<B>) -> TwirpError

Converts to this type from the input type.

impl From<Status> for TwirpError

fn from(status: Status) -> TwirpError

Converts to this type from the input type.

impl IntoResponse for TwirpError

fn into_response(self) -> Response<Body>

Create a response.

impl PartialEq for TwirpError

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

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

1.0.0 · Source§

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 Serialize for TwirpError

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for TwirpError

Auto Trait Implementations§

impl Freeze for TwirpError

impl !RefUnwindSafe for TwirpError

impl Send for TwirpError

impl Sync for TwirpError

impl Unpin for TwirpError

impl !UnwindSafe for TwirpError

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + Sync + 'static,

type Future = Ready<Response<Body>>

The type of future calling this handler returns.

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a tower::Layer to the handler. Read more

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a Service by providing the state

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a Service and no state.

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,