Struct AuthenticatedUser 

pub struct AuthenticatedUser<U>(pub Arc<U>);

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

impl<U> AuthenticatedUser<U>

pub fn get(&self) -> &U

The user.

Trait Implementations

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.

fn clone(&self) -> AuthenticatedUser<U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U> Debug for AuthenticatedUser<U>

where U: Debug,

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

Formats the value using the given formatter.

impl<U> Deref for AuthenticatedUser<U>

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &U

Dereferences the value.

impl<U> FromRequest for AuthenticatedUser<U>

where U: Send + Sync + 'static,

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.

fn from_request( request: Arc<Request>, ) -> Pin<Box<dyn Future<Output = Result<AuthenticatedUser<U>, Error>> + Send>>

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).