Struct SessionMessageStore

pub struct SessionMessageStore { /* private fields */ }

A session-based implementation of flash messages.

SessionMessageStore uses the session machinery provided by actix-session to store and retrieve FlashMessages.

Use either SessionMessageStore::default or SessionMessageStore::default to build an instance of SessionMessageStore.

Disclaimer

Be careful: you need to wrap your application in an additional middleware, in addition to FlashMessagesFramework, that provides persistence for the session data.
actix-session provides a cookie-based implementation of sessions via actix_session::CookieSession.
Alternatively, you can use RedisSession from actix-redis.

Flash messages will not work if you fail to mount a storage backend for your sessions.

You can find examples of application using SessionMessageStore on GitHub: using both cookie-based sessions and Redis-based sessions.

Implementations

impl SessionMessageStore

pub fn new(key: String) -> Self

Build a new SessionMessageStore and specify which key should be used to store outgoing flash messages in the session map.

Trait Implementations

impl Clone for SessionMessageStore

fn clone(&self) -> SessionMessageStore

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SessionMessageStore

fn default() -> Self

Returns the “default value” for a type.

impl FlashMessageStore for SessionMessageStore

fn load(&self, request: &HttpRequest) -> Result<Vec<FlashMessage>, LoadError>

Extract flash messages from an incoming request.

fn store( &self, messages: &[FlashMessage], request: HttpRequest, _response: &mut ResponseHead, ) -> Result<(), StoreError>

Attach flash messages to an outgoing response.