Struct Flash 

pub struct Flash(/* private fields */);

Flash messages set by the previous request, as an extractor.

Extracting them removes them from the session, so each message shows once (Rails’ flash). Rejects like Session when used outside serve or when the secret is missing.

In templates: {% if let Some(notice) = flash.notice() %}<p>{{ notice }}</p>{% endif %}.

Examples

use ocre::Flash;

async fn index(flash: Flash) -> String {
    flash.iter().map(|(kind, message)| format!("{kind}: {message}\n")).collect()
}

Implementations

impl Flash

pub fn get(&self, kind: &str) -> Option<&str>

The message of the given kind, if the previous request set one.

Examples

assert_eq!(ocre::Flash::default().get("warning"), None);

pub fn notice(&self) -> Option<&str>

The notice message (success), same as flash.get("notice").

Examples

assert_eq!(ocre::Flash::default().notice(), None);

pub fn alert(&self) -> Option<&str>

The alert message (failure), same as flash.get("alert").

Examples

assert_eq!(ocre::Flash::default().alert(), None);

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Every (kind, message) pair.

Examples

assert_eq!(ocre::Flash::default().iter().count(), 0);

pub fn is_empty(&self) -> bool

Whether there is no message.

Examples

assert!(ocre::Flash::default().is_empty());

pub fn now(self, kind: &str, message: impl Into<String>) -> Self

These messages plus message of kind, for this response only (Rails’ flash.now): render a page with a message without storing it in the session, e.g. a form shown again with an alert.

Examples

let flash = ocre::Flash::default().now("alert", "Check the highlighted fields.");
assert_eq!(flash.alert(), Some("Check the highlighted fields."));
assert_eq!(flash.clone().now("alert", "Again.").alert(), Some("Again."), "a kind has one message");

Trait Implementations

impl Clone for Flash

fn clone(&self) -> Flash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flash

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Flash

fn default() -> Flash

Returns the “default value” for a type.

impl Eq for Flash

impl<S: Sync> FromRequestParts<S> for Flash

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts(parts: &mut Parts, state: &S) -> Result<Self, Error>

Perform the extraction.

impl PartialEq for Flash

fn eq(&self, other: &Flash) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Flash