Skip to main content

Failure

Struct Failure 

Source
pub struct Failure { /* private fields */ }
Expand description

A failure on its way to the client: status, stable code, public message, internal detail, kind and headers.

Renderers read the message only through Failure::public_message, which is fixed for every 5xx.

§Examples

use davidrs::http::{Failure, StatusCode, INTERNAL_MESSAGE};

let refused = Failure::new(StatusCode::CONFLICT, "ERROR_ORDER_CLOSED", "The order is closed");
assert_eq!(refused.public_message(), "The order is closed");

let broken = Failure::new(StatusCode::BAD_GATEWAY, "FAULT_UPSTREAM", "connect 10.0.0.7 refused");
assert_eq!(broken.public_message(), INTERNAL_MESSAGE);
assert!(broken.internal_detail().contains("10.0.0.7"));

Implementations§

Source§

impl Failure

Source

pub fn new( status: StatusCode, code: &'static str, message: impl Into<String>, ) -> Self

A failure with an explicit status and a client-safe message.

A 5xx status discards message at render time; put anything diagnostic in Failure::with_detail instead of the message.

Source

pub fn internal(code: &'static str, detail: impl Into<String>) -> Self

A 500 whose detail is kept for diagnostics and never rendered.

Source

pub fn from_error(code: &'static str, error: &dyn Error) -> Self

A 500 built from an error, keeping its whole source chain as the detail.

Source

pub fn with_detail(self, detail: impl Into<String>) -> Self

Attaches internal diagnostic text, never rendered.

Source

pub fn with_kind(self, kind: FailureKind) -> Self

Records where the failure came from.

Source

pub fn with_header(self, name: &str, value: &str) -> Self

Adds a response header that survives rendering.

It replaces a header of the same name the renderer sets. Adding a name again keeps every value, as set-cookie needs.

An invalid name or value is dropped rather than panicking: a malformed header must not turn a 429 into a crash.

Source

pub fn with_headers<I, K, V>(self, headers: I) -> Self
where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Adds several response headers, dropping invalid ones as Failure::with_header does.

Source

pub fn status(&self) -> StatusCode

The status that will be rendered.

Source

pub fn code(&self) -> &'static str

The stable machine-readable code.

Source

pub fn kind(&self) -> FailureKind

Where the failure came from.

Source

pub fn headers(&self) -> &[(HeaderName, HeaderValue)]

The headers a renderer puts on the response.

Source

pub fn public_message(&self) -> &str

The message a client may see: the message for a 4xx, and INTERNAL_MESSAGE for every 5xx however the failure was built.

Renderers must use this accessor for client-visible text. internal_detail and Debug are diagnostic only.

Source

pub fn internal_detail(&self) -> String

The unredacted message and the detail joined as message: detail, for a deliberate diagnostic. The message is left out when it is empty or INTERNAL_MESSAGE.

Never put this in a response.

Source

pub fn is_server_error(&self) -> bool

Whether the status is a 5xx, the failures worth logging at error level.

Trait Implementations§

Source§

impl Debug for Failure

Source§

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

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

impl Display for Failure

Source§

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

Shows only what a client may see, so an accidental {failure} in a response body cannot disclose internals.

Source§

impl Eq for Failure

Source§

impl Error for Failure

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<RuntimeError> for Failure

A 500 whose detail is the error’s source chain: ERROR_TIMEOUT with kind FailureKind::Deadline for a deadline, ERROR_LIMIT_EXCEEDED for a bounded limit, FAULT_UNHANDLED for anything else.

Source§

fn from(error: RuntimeError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Failure

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Failure

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T, O> Matches<O> for T
where T: PartialEq<O>,

Source§

fn validate_matches(&self, other: &O) -> bool

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Requirement<T> for T

Source§

const REQUIRED: bool = const REQUIRED: bool = true;

Whether a request without the value is refused.
Source§

fn fulfill(found: Option<T>) -> Option<T>

Converts what was found, or None when a required value is missing.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToCompactString for T
where T: Display,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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