actix/actix-web
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-27 17:52:56 +01:00
Code Issues Releases Wiki Activity

update doc strings

Browse Source
This commit is contained in:
Nikolay Kim 2017-12-19 16:09:19 -08:00
parent 64d867d9a1
commit 626999bcc9
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/middlewares/session.rs
View File

@ -20,6 +20,23 @@ use httpresponse::HttpResponse;
use middlewares::{Middleware, Started, Response};
/// The helper trait to obtain your session data from a request.
///
/// ```rust
/// use actix_web::*;
/// use actix_web::middlewares::RequestSession;
///
/// fn index(mut req: HttpRequest) -> Result<&'static str> {
/// // access session data
/// if let Some(count) = req.session().get::<i32>("counter")? {
/// req.session().set("counter", count+1)?;
/// } else {
/// req.session().set("counter", 1)?;
/// }
///
/// Ok("Welcome!")
/// }
/// # fn main() {}
/// ```
pub trait RequestSession {
fn session(&mut self) -> Session;
}
@ -101,12 +118,13 @@ unsafe impl Sync for SessionImplBox {}
/// ```rust
/// # extern crate actix;
/// # extern crate actix_web;
/// # use actix_web::middlewares::{SessionStorage, CookieSessionBackend};
/// use actix_web::*;
///
/// fn main() {
/// let app = Application::new()
/// .middleware(middlewares::SessionStorage::new( // <- create session middlewares
/// middlewares::CookieSessionBackend::build(&[0; 32]) // <- create cookie session backend
/// let app = Application::new().middleware(
/// SessionStorage::new( // <- create session middlewares
/// CookieSessionBackend::build(&[0; 32]) // <- create cookie session backend
/// .secure(false)
/// .finish())
/// );