[−][src]Struct requiem_session::CookieSession
Use cookies for session storage.
CookieSession
creates sessions which are limited to storing
fewer than 4000 bytes of data (as the payload must fit into a single
cookie). An Internal Server Error is generated if the session contains more
than 4000 bytes.
A cookie may have a security policy of signed or private. Each has a
respective CookieSessionBackend
constructor.
A signed cookie is stored on the client as plaintext alongside a signature such that the cookie may be viewed but not modified by the client.
A private cookie is stored on the client as encrypted text such that it may neither be viewed nor modified by the client.
The constructors take a key as an argument. This is the private key for cookie session - when this value is changed, all session data is lost. The constructors will panic if the key is less than 32 bytes in length.
The backend relies on cookie
crate to create and read cookies.
By default all cookies are percent encoded, but certain symbols may
cause troubles when reading cookie, if they are not properly percent encoded.
Example
use requiem_session::CookieSession; use requiem_web::{web, App, HttpResponse, HttpServer}; fn main() { let app = App::new().wrap( CookieSession::signed(&[0; 32]) .domain("www.rust-lang.org") .name("requiem_session") .path("/") .secure(true)) .service(web::resource("/").to(|| HttpResponse::Ok())); }
Methods
impl CookieSession
[src]
pub fn signed(key: &[u8]) -> CookieSession
[src]
Construct new signed CookieSessionBackend
instance.
Panics if key length is less than 32 bytes.
pub fn private(key: &[u8]) -> CookieSession
[src]
Construct new private CookieSessionBackend
instance.
Panics if key length is less than 32 bytes.
pub fn path<S: Into<String>>(self, value: S) -> CookieSession
[src]
Sets the path
field in the session cookie being built.
pub fn name<S: Into<String>>(self, value: S) -> CookieSession
[src]
Sets the name
field in the session cookie being built.
pub fn domain<S: Into<String>>(self, value: S) -> CookieSession
[src]
Sets the domain
field in the session cookie being built.
pub fn secure(self, value: bool) -> CookieSession
[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 http_only(self, value: bool) -> CookieSession
[src]
Sets the http_only
field in the session cookie being built.
pub fn same_site(self, value: SameSite) -> CookieSession
[src]
Sets the same_site
field in the session cookie being built.
pub fn max_age(self, seconds: i64) -> CookieSession
[src]
Sets the max-age
field in the session cookie being built.
pub fn max_age_time(self, value: Duration) -> CookieSession
[src]
Sets the max-age
field in the session cookie being built.
Trait Implementations
impl<S, B: 'static> Transform<S> for CookieSession where
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>>,
S::Future: 'static,
S::Error: 'static,
[src]
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>>,
S::Future: 'static,
S::Error: 'static,
type Request = ServiceRequest
Requests handled by the service.
type Response = ServiceResponse<B>
Responses given by the service.
type Error = S::Error
Errors produced by the service.
type InitError = ()
Errors produced while building a transform service.
type Transform = CookieSessionMiddleware<S>
The TransformService
value created by this factory
type Future = Ready<Result<Self::Transform, Self::InitError>>
The future response value.
fn new_transform(&self, service: S) -> Self::Future
[src]
fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
F: Fn(Self::InitError) -> E + Clone,
[src]
F: Fn(Self::InitError) -> E + Clone,
Auto Trait Implementations
impl !RefUnwindSafe for CookieSession
impl !Send for CookieSession
impl !Sync for CookieSession
impl Unpin for CookieSession
impl UnwindSafe for CookieSession
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,