actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-30 18:34:36 +01:00
Code Issues Releases Wiki Activity

Clarify how to use Session::set_session() (#41)

Browse Source 
* Clarify in examples how to use Session::set_session().

* Add a doc example for Session::set_session().
This commit is contained in:
Pieter Frenssen 2020-04-07 19:49:58 +03:00 committed by GitHub
parent a72d4aa0c8
commit ede715374b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
actix-session/src/lib.rs
View File

@ -180,6 +180,24 @@ impl Session {
} }
} }
/// Adds the given key-value pairs to the session on the request.
///
/// Values that match keys already existing on the session will be overwritten. Values should
/// already be JSON serialized.
///
/// # Example
///
/// ```
/// # use actix_session::Session;
/// # use actix_web::test;
/// #
/// let mut req = test::TestRequest::default().to_srv_request();
///
/// Session::set_session(
/// vec![("counter".to_string(), serde_json::to_string(&0).unwrap())].into_iter(),
/// &mut req,
/// );
/// ```
pub fn set_session( pub fn set_session(
data: impl Iterator<Item = (String, String)>, data: impl Iterator<Item = (String, String)>,
req: &mut ServiceRequest, req: &mut ServiceRequest,
@ -258,7 +276,7 @@ mod tests {
let mut req = test::TestRequest::default().to_srv_request(); let mut req = test::TestRequest::default().to_srv_request();
Session::set_session( Session::set_session(
vec![("key".to_string(), "\"value\"".to_string())].into_iter(), vec![("key".to_string(), serde_json::to_string("value").unwrap())].into_iter(),
&mut req, &mut req,
); );
let session = Session::get_session(&mut *req.extensions_mut()); let session = Session::get_session(&mut *req.extensions_mut());
@ -279,13 +297,13 @@ mod tests {
let mut req = test::TestRequest::default().to_srv_request(); let mut req = test::TestRequest::default().to_srv_request();
Session::set_session( Session::set_session(
vec![("key".to_string(), "\"value\"".to_string())].into_iter(), vec![("key".to_string(), serde_json::to_string(&true).unwrap())].into_iter(),
&mut req, &mut req,
); );
let session = req.get_session(); let session = req.get_session();
let res = session.get::<String>("key").unwrap(); let res = session.get("key").unwrap();
assert_eq!(res, Some("value".to_string())); assert_eq!(res, Some(true));
} }
#[test] #[test]
@ -293,13 +311,13 @@ mod tests {
let mut req = test::TestRequest::default().to_srv_request(); let mut req = test::TestRequest::default().to_srv_request();
Session::set_session( Session::set_session(
vec![("key".to_string(), "\"value\"".to_string())].into_iter(), vec![("key".to_string(), serde_json::to_string(&10).unwrap())].into_iter(),
&mut req, &mut req,
); );
let session = req.head_mut().get_session(); let session = req.head_mut().get_session();
let res = session.get::<String>("key").unwrap(); let res = session.get::<u32>("key").unwrap();
assert_eq!(res, Some("value".to_string())); assert_eq!(res, Some(10));
} }
#[test] #[test]