# Struct actix_identity::Identity

source · [−]

    pub struct Identity(_);

Expand description

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

source

### impl Identity

source

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

source

#### pub fn remember(&self, identity: String)

Remember identity.

source

#### pub fn forget(&self)

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

## Trait Implementations

source

### impl Clone for Identity

source

#### fn clone(&self) -> Identity

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

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 Error = Error

The associated error which can be returned.

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

Future that resolves to a Self.

source

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

Create a Self from request parts asynchronously.

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

Create a Self from request head asynchronously. Read more

## Auto Trait Implementations

### impl !RefUnwindSafe for Identity

### impl !Send for Identity

### impl !Sync for Identity

### impl Unpin for Identity

### impl !UnwindSafe for Identity

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

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · 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>,

const: unstable · 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> Same<T> for T

#### type Output = T

Should always be `Self`

source

### impl<T> ToOwned for T where
T: Clone,

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

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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

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