Skip to main content

JsonError

Struct JsonError 

Source
pub struct JsonError {
    pub status: StatusCode,
    pub message: String,
}
Expand description

A structured JSON error response.

Serializes to {"error": {"status": 400, "message": "..."}}.

§Example

use typeway_server::error::JsonError;
use typeway_server::Json;

#[derive(serde::Serialize)]
struct User { id: u32 }

async fn get_user() -> Result<Json<User>, JsonError> {
    // Return a structured JSON error on failure:
    Err(JsonError::not_found("user not found"))
}

Fields§

§status: StatusCode§message: String

Implementations§

Source§

impl JsonError

Source

pub fn new(status: StatusCode, message: impl Into<String>) -> Self

Create a new error with the given status code and message.

Source

pub fn bad_request(message: impl Into<String>) -> Self

400 Bad Request.

Source

pub fn unauthorized(message: impl Into<String>) -> Self

401 Unauthorized.

Source

pub fn forbidden(message: impl Into<String>) -> Self

403 Forbidden.

Source

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

404 Not Found.

Source

pub fn conflict(message: impl Into<String>) -> Self

409 Conflict.

Source

pub fn unprocessable(message: impl Into<String>) -> Self

422 Unprocessable Entity.

Source

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

500 Internal Server Error.

Trait Implementations§

Source§

impl Clone for JsonError

Source§

fn clone(&self) -> JsonError

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
Source§

impl Debug for JsonError

Source§

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

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

impl Display for JsonError

Source§

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

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

impl Error for JsonError

1.30.0 · 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
Source§

impl From<(StatusCode, String)> for JsonError

Implement From<(StatusCode, String)> so existing extractor errors can be converted to JsonError automatically.

Source§

fn from((status, message): (StatusCode, String)) -> Self

Converts to this type from the input type.
Source§

impl IntoResponse for JsonError

Source§

fn into_response(self) -> Response<BoxBody>

Convert this value into an HTTP response.

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> RenderAs<TextFormat> for T
where T: Display,

Source§

fn render(&self) -> Result<(Vec<u8>, &'static str), String>

Render this value into bytes and its content-type string.
Source§

impl<B, C, R, H> Serves<VersionedApi<B, C, R>> for H
where R: ApiSpec, H: Serves<R>,

Source§

fn register(self, router: &mut Router)

Register all handlers into the router.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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 = Infallible

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

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

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> IsEndpoint<T> for T