Skip to main content

RejectContext

Struct RejectContext 

Source
#[non_exhaustive]
pub struct RejectContext<'a> { pub rejection: &'a TokenRejection, pub status: StatusCode, pub request: &'a Parts, }
Available on crate feature tower only.
Expand description

What an on_reject callback (HttpAuthLayerBuilder::on_reject, or the axum layer’s AuthLayerBuilder::on_reject) is told about a refusal.

#[non_exhaustive]: read its fields; more may be added without a breaking change.

Its Debug prints the rejection, the status, the method, the URI’s path (any query as ?***: a client may send an RFC 6750 §2.3 access_token there) and version, and the request’s header NAMES — never a header value, so tracing::warn!(?cx, "refused") cannot log the presented credential (which, for an insufficient-scope refusal, is a validly signed, unexpired token).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§rejection: &'a TokenRejection

Why the request was refused. TokenRejection::Invalid’s reason is for logs only — never put it in the response.

§status: StatusCode

The status the response will carry (401, or 403 for insufficient scope), whatever the callback sets.

§request: &'a Parts

The refused request’s method, URI, version, headers and extensions — for content negotiation (Accept), or a per-path error shape.

Trait Implementations§

Source§

impl Debug for RejectContext<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for RejectContext<'a>

§

impl<'a> !UnwindSafe for RejectContext<'a>

§

impl<'a> Freeze for RejectContext<'a>

§

impl<'a> Send for RejectContext<'a>

§

impl<'a> Sync for RejectContext<'a>

§

impl<'a> Unpin for RejectContext<'a>

§

impl<'a> UnsafeUnpin for RejectContext<'a>

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> 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> 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, 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<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