Struct FlashMessage

pub struct FlashMessage { /* private fields */ }

A one-time user notification.

Flash messages are made of a Level and a string of content.
The message level can be used for filtering and rendering - for example:

• Only show flash messages at info level or above in a production environment, while retaining debug level messages for local development;
• Use different colours, in the UI, to display messages (e.g. red for errors, orange for warnings, etc.);

You can build a flash message via FlashMessage::new by specifying its content and Level. You can also use the shorter level-based constructors - e.g. FlashMessage::info.

Implementations

impl FlashMessage

pub fn new(content: String, level: Level) -> Self

Build a FlashMessage by specifying its content and Level.

pub fn content(&self) -> &str

The string content of this flash message.

pub fn level(&self) -> Level

The Level of this flash message.

pub fn info<S: Into<String>>(content: S) -> Self

Build an info-level FlashMessage by specifying its content.

pub fn debug<S: Into<String>>(content: S) -> Self

Build a debug-level FlashMessage by specifying its content.

pub fn success<S: Into<String>>(content: S) -> Self

Build a success-level FlashMessage by specifying its content.

pub fn warning<S: Into<String>>(content: S) -> Self

Build a warning-level FlashMessage by specifying its content.

pub fn error<S: Into<String>>(content: S) -> Self

Build an error-level FlashMessage by specifying its content.

pub fn send(self)

Attach this FlashMessage to the outgoing request.

The message will be dropped if its Level is below the minimum level specified when configuring FlashMessagesFramework via FlashMessagesFrameworkBuilder::minimum_level.

This method will panic if FlashMessagesFramework has not been registered as a middleware.

Trait Implementations

impl Clone for FlashMessage

fn clone(&self) -> FlashMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for FlashMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FlashMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.