Struct actix_web::middleware::identity::CookieIdentityPolicy
source · pub struct CookieIdentityPolicy(_);
Expand description
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),
));
}
Implementations
sourceimpl CookieIdentityPolicy
impl CookieIdentityPolicy
sourcepub fn new(key: &[u8]) -> CookieIdentityPolicy
pub fn new(key: &[u8]) -> CookieIdentityPolicy
Construct new CookieIdentityPolicy
instance.
Panics if key length is less than 32 bytes.
sourcepub fn path<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
pub fn path<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
Sets the path
field in the session cookie being built.
sourcepub fn name<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
pub fn name<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
Sets the name
field in the session cookie being built.
sourcepub fn domain<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
pub fn domain<S: Into<String>>(self, value: S) -> CookieIdentityPolicy
Sets the domain
field in the session cookie being built.
sourcepub fn secure(self, value: bool) -> CookieIdentityPolicy
pub fn secure(self, value: bool) -> CookieIdentityPolicy
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
sourcepub fn max_age(self, value: Duration) -> CookieIdentityPolicy
pub fn max_age(self, value: Duration) -> CookieIdentityPolicy
Sets the max-age
field in the session cookie being built.
Trait Implementations
sourceimpl<S> IdentityPolicy<S> for CookieIdentityPolicy
impl<S> IdentityPolicy<S> for CookieIdentityPolicy
type Identity = CookieIdentity
type Identity = CookieIdentity
The associated identity
type Future = FutureResult<CookieIdentity, Error>
type Future = FutureResult<CookieIdentity, Error>
The return type of the middleware
sourcefn from_request(&self, req: &HttpRequest<S>) -> Self::Future
fn from_request(&self, req: &HttpRequest<S>) -> Self::Future
Parse the session from request and load data from a service identity.
Auto Trait Implementations
impl RefUnwindSafe for CookieIdentityPolicy
impl !Send for CookieIdentityPolicy
impl !Sync for CookieIdentityPolicy
impl Unpin for CookieIdentityPolicy
impl UnwindSafe for CookieIdentityPolicy
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more