Struct actix_identity::Identity

pub struct Identity(_);

The extractor type to obtain your identity from a request.

use actix_web::*;
use actix_identity::Identity;

#[get("/")]
async fn index(id: Identity) -> impl Responder {
    // access request identity
    if let Some(id) = id.identity() {
        format!("Welcome! {}", id)
    } else {
        "Welcome Anonymous!".to_owned()
    }
}

#[post("/login")]
async fn login(id: Identity) -> impl Responder {
    // remember identity
    id.remember("User1".to_owned());

    HttpResponse::Ok()
}

#[post("/logout")]
async fn logout(id: Identity) -> impl Responder {
    // remove identity
    id.forget();

    HttpResponse::Ok()
}

Implementations

impl Identity

pub fn identity(&self) -> Option<String>

Return the claimed identity of the user associated request or None if no identity can be found associated with the request.

pub fn remember(&self, identity: String)

Remember identity.

pub fn forget(&self)

This method is used to ‘forget’ the current identity on subsequent requests.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl FromRequest for Identity

Extractor implementation for Identity type.

use actix_identity::Identity;

#[get("/")]
async fn index(id: Identity) -> impl Responder {
    // access request identity
    if let Some(id) = id.identity() {
        format!("Welcome! {}", id)
    } else {
        "Welcome Anonymous!".to_owned()
    }
}

type Config = ()

Configuration for this extractor.

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Identity, Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

pub fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

pub fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.