Skip to main content

StructError

Enum StructError 

Source
#[non_exhaustive]
pub enum StructError { InvalidPath { path: String, }, InvalidSubpath { path: String, }, BodyExpected { path: String, }, BodyUnexpected { path: String, }, Decode { path: String, source: Error, }, Arguments { path: String, message: String, }, Execution { path: String, message: String, }, }
Expand description

Errors produced while handling struct-backed endpoints.

Non-exhaustive: match with a wildcard arm, or use StructError::code to map any error onto its protocol ErrorCode.

There is no Serialize variant. structio’s writers cannot fail — a structio::json::Write impl returns () — so encoding a response is infallible and the only failures left are about the request: a path that does not resolve, a body that should or should not be there, a body that does not parse, and a handler that reported its own failure.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

InvalidPath

Fields

§path: String
§

InvalidSubpath

Fields

§path: String
§

BodyExpected

Fields

§path: String
§

BodyUnexpected

Fields

§path: String
§

Decode

The request body did not parse as the endpoint’s type.

source is structio::Error, a Copy code-and-offset pair rather than an allocated message, and it carries the offending key when the reader knew one.

Fields

§path: String
§source: Error
§

Arguments

The body of a multi-argument method call was the wrong shape — the wrong number of positional arguments, or neither an array nor an object.

Distinct from Decode, which is one argument failing to parse as its own type. This one is about the envelope, and it carries a message of repe’s own because no parser produced it.

Fields

§path: String
§message: String
§

Execution

Fields

§path: String
§message: String

Implementations§

Trait Implementations§

Source§

impl Debug for StructError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for StructError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for StructError

Source§

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

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.