Struct actix_web::middleware::identity::CookieIdentityPolicy
[−]
[src]
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::App; use actix_web::middleware::identity::{IdentityService, CookieIdentityPolicy}; 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
type Future = FutureResult<CookieIdentity, Error>
fn from_request(&self, req: &mut HttpRequest<S>) -> Self::Future
[src]
Parse the session from request and load data from a service identity.