# Struct actix_identity::IdentityMiddleware

source ·

    pub struct IdentityMiddleware { /* private fields */ }

Expand description

Identity management middleware.

    use actix_web::{cookie::Key, App, HttpServer};
    use actix_session::storage::RedisSessionStore;
    use actix_identity::{Identity, IdentityMiddleware};
    use actix_session::{Session, SessionMiddleware};

    #[actix_web::main]
    async fn main() {
        let secret_key = Key::generate();
        let redis_store = RedisSessionStore::new("redis://127.0.0.1:6379").await.unwrap();

        HttpServer::new(move || {
           App::new()
               // Install the identity framework first.
               .wrap(IdentityMiddleware::default())
               // The identity system is built on top of sessions.
               // You must install the session middleware to leverage `actix-identity`.
               .wrap(SessionMiddleware::new(redis_store.clone(), secret_key.clone()))
        })
    }

## Implementations§

source §

### impl IdentityMiddleware

source

#### pub fn builder() -> IdentityMiddlewareBuilder

A fluent API to configure `IdentityMiddleware`.

## Trait Implementations§

source §

### impl Clone for IdentityMiddleware

source §

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

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 Default for IdentityMiddleware

source §

#### fn default() -> IdentityMiddleware

Returns the “default value” for a type. Read more
source §

### impl<S, B> Transform<S, ServiceRequest> for IdentityMiddleware
where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static, S::Future: 'static, B: MessageBody + 'static,

§

#### type Response = ServiceResponse<B>

Responses produced by the service.
§

#### type Error = Error

Errors produced by the service.
§

#### type Transform = InnerIdentityMiddleware<S>

The `TransformService` value created by this factory
§

#### type InitError = ()

Errors produced while building a transform service.
§

#### type Future = Ready<Result<<IdentityMiddleware as Transform<S, ServiceRequest>>::Transform, <IdentityMiddleware as Transform<S, ServiceRequest>>::InitError>>

The future response value.
source §

#### fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

## Auto Trait Implementations§

§

### impl RefUnwindSafe for IdentityMiddleware

§

### impl !Send for IdentityMiddleware

§

### impl !Sync for IdentityMiddleware

§

### impl Unpin for IdentityMiddleware

§

### impl UnwindSafe for IdentityMiddleware

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

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

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

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

§

### impl<T> WithSubscriber for T

§

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

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more