# actix_web::middleware::identity::CookieIdentityPolicy - Rust
API documentation for the Rust `CookieIdentityPolicy` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, CookieIdentityPolicy

# [−] [src] Struct actix_web::middleware::identity::CookieIdentityPolicy

    pub struct CookieIdentityPolicy(_);

Use cookies for request identity storage.

The constructors take a key as an argument. This is the private key for cookie - when this value is changed, all identities are lost. The constructors will panic if the key is less than 32 bytes in length.

# Example

    use actix_web::middleware::identity::{CookieIdentityPolicy, IdentityService};
    use actix_web::App;

    fn main() {
        let app = App::new().middleware(IdentityService::new(
            // <- create identity middleware
            CookieIdentityPolicy::new(&[0; 32])  // <- construct cookie policy
                   .domain("www.rust-lang.org")
                   .name("actix_auth")
                   .path("/")
                   .secure(true),
        ));
    }

## Methods

###

`impl CookieIdentityPolicy`

[src]

####

`pub fn new(key: &[u8]) -> CookieIdentityPolicy`

[src]

Construct new `CookieIdentityPolicy` instance.

Panics if key length is less than 32 bytes.

####

`pub fn path<S: Into<String>>(self, value: S) -> CookieIdentityPolicy`

[src]

Sets the `path` field in the session cookie being built.

####

`pub fn name<S: Into<String>>(self, value: S) -> CookieIdentityPolicy`

[src]

Sets the `name` field in the session cookie being built.

####

`pub fn domain<S: Into<String>>(self, value: S) -> CookieIdentityPolicy`

[src]

Sets the `domain` field in the session cookie being built.

####

`pub fn secure(self, value: bool) -> CookieIdentityPolicy`

[src]

Sets the `secure` field in the session cookie being built.

If the `secure` field is set, a cookie will only be transmitted when the connection is secure - i.e. `https`

####

`pub fn max_age(self, value: Duration) -> CookieIdentityPolicy`

[src]

Sets the `max-age` field in the session cookie being built.

## Trait Implementations

###

`impl<S> IdentityPolicy<S> for CookieIdentityPolicy`

[src]

#### `type Identity = CookieIdentity`

The associated identity

#### `type Future = FutureResult<CookieIdentity, Error>`

The return type of the middleware

####

`fn from_request(&self, req: &HttpRequest<S>) -> Self::Future`

[src]

Parse the session from request and load data from a service identity.

## Auto Trait Implementations

###

`impl !Send for CookieIdentityPolicy`

###

`impl !Sync for CookieIdentityPolicy`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

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

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

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

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

The type returned in the event of a conversion error.

####

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

[src]

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

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

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

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)