Skip to main content

AuthenticatedUser

Struct AuthenticatedUser 

Source
pub struct AuthenticatedUser<U>(pub Arc<U>);
Expand description

The user resolved for this request, stored in its extensions.

A newtype rather than a bare U so it cannot be confused with any other value of the same type an application might attach.

Tuple Fields§

§0: Arc<U>

Implementations§

Source§

impl<U> AuthenticatedUser<U>

Source

pub fn get(&self) -> &U

The user.

Trait Implementations§

Source§

impl<U> Clone for AuthenticatedUser<U>

Cloning shares the user rather than copying it, so this holds whatever U is — a derived Clone would have demanded U: Clone for no reason.

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<U: Debug> Debug for AuthenticatedUser<U>

Source§

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

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

impl<U> Deref for AuthenticatedUser<U>

Source§

type Target = U

The resulting type after dereferencing.
Source§

fn deref(&self) -> &U

Dereferences the value.
Source§

impl<U: Send + Sync + 'static> FromRequest for AuthenticatedUser<U>

The authenticated user, as a controller parameter.

The framework supplies it, which is why an action can read

ⓘ
pub async fn me(user: AuthenticatedUser<User>) -> Result<Response> {
    Ok(Response::json(user.get()))
}

rather than taking the whole request and digging the user out of it.

Fails with 401 when there is none — which can only happen on a route with no Authenticate middleware in front, so the message says so rather than blaming the caller for a wiring mistake.

Source§

fn from_request(request: Arc<Request>) -> BoxedFuture<Result<Self>>

Build Self from the request, or fail with the error the client should see (a 400 for a malformed body, a 422 for a failed contract).

Auto Trait Implementations§

§

impl<U> Freeze for AuthenticatedUser<U>
where Arc<U>: Freeze,

§

impl<U> RefUnwindSafe for AuthenticatedUser<U>
where Arc<U>: RefUnwindSafe,

§

impl<U> Send for AuthenticatedUser<U>
where Arc<U>: Send,

§

impl<U> Sync for AuthenticatedUser<U>
where Arc<U>: Sync,

§

impl<U> Unpin for AuthenticatedUser<U>
where Arc<U>: Unpin,

§

impl<U> UnsafeUnpin for AuthenticatedUser<U>
where Arc<U>: UnsafeUnpin,

§

impl<U> UnwindSafe for AuthenticatedUser<U>
where Arc<U>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Actor for T
where T: Send + Sync + 'static,

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<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> Event for T
where T: Send + Sync + 'static,

Source§

fn event_name() -> &'static str
where Self: Sized,

A human-readable name, used by wildcard listeners and log output. Always the Rust type path; see the trait docs.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, 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