[−][src]Struct actix_session::Session
The high-level interface you use to modify session data.
Session object could be obtained with
RequestSession::session
method. RequestSession
trait is implemented for HttpRequest
.
use actix_session::Session; use actix_web::*; fn index(session: Session) -> Result<&'static str> { // access session data if let Some(count) = session.get::<i32>("counter")? { session.set("counter", count + 1)?; } else { session.set("counter", 1)?; } Ok("Welcome!") }
Methods
impl Session
[src]
pub fn get<T: DeserializeOwned>(&self, key: &str) -> Result<Option<T>, Error>
[src]
Get a value
from the session.
pub fn set<T: Serialize>(&self, key: &str, value: T) -> Result<(), Error>
[src]
Set a value
from the session.
pub fn remove(&self, key: &str)
[src]
Remove value from the session.
pub fn clear(&self)
[src]
Clear the session.
pub fn purge(&self)
[src]
Removes session, both client and server side.
pub fn renew(&self)
[src]
Renews the session key, assigning existing session state to new key.
pub fn set_session(
data: impl Iterator<Item = (String, String)>,
req: &mut ServiceRequest
)
[src]
data: impl Iterator<Item = (String, String)>,
req: &mut ServiceRequest
)
pub fn get_changes<B>(
res: &mut ServiceResponse<B>
) -> (SessionStatus, Option<impl Iterator<Item = (String, String)>>)
[src]
res: &mut ServiceResponse<B>
) -> (SessionStatus, Option<impl Iterator<Item = (String, String)>>)
Trait Implementations
impl FromRequest for Session
[src]
Extractor implementation for Session type.
use actix_session::Session; fn index(session: Session) -> Result<&'static str> { // access session data if let Some(count) = session.get::<i32>("counter")? { session.set("counter", count + 1)?; } else { session.set("counter", 1)?; } Ok("Welcome!") }
type Error = Error
The associated error which can be returned.
type Future = Ready<Result<Session, Error>>
Future that resolves to a Self
type Config = ()
Configuration for this extractor
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]
fn configure<F>(f: F) -> Self::Config where
F: FnOnce(Self::Config) -> Self::Config,
[src]
F: FnOnce(Self::Config) -> Self::Config,
Auto Trait Implementations
impl !RefUnwindSafe for Session
impl !Send for Session
impl !Sync for Session
impl Unpin for Session
impl !UnwindSafe for Session
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, 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>,