Struct cosworth::prelude::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§
source§impl 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>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
pub fn path<S>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
Sets the path
field in the session cookie being built.
sourcepub fn name<S>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
pub fn name<S>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
Sets the name
field in the session cookie being built.
sourcepub fn domain<S>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
pub fn domain<S>(self, value: S) -> CookieIdentityPolicywhere
S: Into<String>,
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.
sourcepub fn same_site(self, same_site: SameSite) -> CookieIdentityPolicy
pub fn same_site(self, same_site: SameSite) -> CookieIdentityPolicy
Sets the same_site
field in the session cookie being built.
Trait Implementations§
source§impl<S> IdentityPolicy<S> for CookieIdentityPolicy
impl<S> IdentityPolicy<S> for CookieIdentityPolicy
§type Future = FutureResult<CookieIdentity, Error>
type Future = FutureResult<CookieIdentity, Error>
source§fn from_request(
&self,
req: &HttpRequest<S>
) -> <CookieIdentityPolicy as IdentityPolicy<S>>::Future
fn from_request(
&self,
req: &HttpRequest<S>
) -> <CookieIdentityPolicy as IdentityPolicy<S>>::Future
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§
source§impl<T> IntoSql for T
impl<T> IntoSql for T
source§fn into_sql<T>(self) -> Self::Expressionwhere
Self: AsExpression<T> + Sized,
fn into_sql<T>(self) -> Self::Expressionwhere
Self: AsExpression<T> + Sized,
self
to an expression for Diesel’s query builder. Read moresource§fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expressionwhere
&'a Self: AsExpression<T>,
fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expressionwhere
&'a Self: AsExpression<T>,
&self
to an expression for Diesel’s query builder. Read more