From 626999bcc927f6a092980076159094204e4a61bf Mon Sep 17 00:00:00 2001 From: Nikolay Kim Date: Tue, 19 Dec 2017 16:09:19 -0800 Subject: [PATCH] update doc strings --- src/middlewares/session.rs | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/src/middlewares/session.rs b/src/middlewares/session.rs index 25caffa6e..6edba1983 100644 --- a/src/middlewares/session.rs +++ b/src/middlewares/session.rs @@ -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::("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,14 +118,15 @@ 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 -/// .secure(false) -/// .finish()) +/// let app = Application::new().middleware( +/// SessionStorage::new( // <- create session middlewares +/// CookieSessionBackend::build(&[0; 32]) // <- create cookie session backend +/// .secure(false) +/// .finish()) /// ); /// } /// ```