Struct rocket::response::Flash

pub struct Flash<R> { /* private fields */ }

Sets a “flash” cookie that will be removed when it is accessed. The analogous request type is FlashMessage.

This type makes it easy to send messages across requests. It is typically used for “status” messages after redirects. For instance, if a user attempts to visit a page he/she does not have access to, you may want to redirect the user to a safe place and show a message indicating what happened on the redirected page. The message should only persist for a single request. This can be accomplished with this type.

Usage

Each Flash message consists of a kind and message. A generic constructor (new) can be used to construct a message of any kind, while the warning, success, and error constructors create messages with the corresponding kinds.

Messages can be retrieved on the request side via the FlashMessage type and the kind and message methods.

Response

The Responder implementation for Flash sets the message cookie and then uses the passed in responder res to complete the response. In other words, it simply sets a cookie and delegates the rest of the response handling to the wrapped responder.

Example

The following routes illustrate the use of a Flash message on both the request and response sides.

use rocket::response::{Flash, Redirect};
use rocket::request::FlashMessage;

#[post("/login/<name>")]
fn login(name: &str) -> Result<&'static str, Flash<Redirect>> {
    if name == "special_user" {
        Ok("Hello, special user!")
    } else {
        Err(Flash::error(Redirect::to(uri!(index)), "Invalid username."))
    }
}

#[get("/")]
fn index(flash: Option<FlashMessage<'_>>) -> String {
    flash.map(|flash| format!("{}: {}", flash.kind(), flash.message()))
         .unwrap_or_else(|| "Welcome!".to_string())
}

On the response side (in login), a Flash error message is set if some fictional authentication failed, and the user is redirected to "/". On the request side (in index), the handler emits the flash message if there is one and otherwise emits a standard welcome message. Note that if the user were to refresh the index page after viewing a flash message, the user would receive the standard welcome message.

Implementations

impl<R> Flash<R>

pub fn new<K: Into<String>, M: Into<String>>( res: R, kind: K, message: M, ) -> Flash<R>

Constructs a new Flash message with the given kind, message, and underlying responder.

Examples

Construct a “suggestion” message with contents “Try this out!” that redirects to “/”.

use rocket::response::{Redirect, Flash};

let message = Flash::new(Redirect::to("/"), "suggestion", "Try this out!");

pub fn success<S: Into<String>>(responder: R, message: S) -> Flash<R>

Constructs a “success” Flash message with the given responder and message.

Examples

Construct a “success” message with contents “It worked!” that redirects to “/”.

use rocket::response::{Redirect, Flash};

let message = Flash::success(Redirect::to("/"), "It worked!");

pub fn warning<S: Into<String>>(responder: R, message: S) -> Flash<R>

Constructs a “warning” Flash message with the given responder and message.

Examples

Construct a “warning” message with contents “Watch out!” that redirects to “/”.

use rocket::response::{Redirect, Flash};

let message = Flash::warning(Redirect::to("/"), "Watch out!");

pub fn error<S: Into<String>>(responder: R, message: S) -> Flash<R>

Constructs an “error” Flash message with the given responder and message.

Examples

Construct an “error” message with contents “Whoops!” that redirects to “/”.

use rocket::response::{Redirect, Flash};

let message = Flash::error(Redirect::to("/"), "Whoops!");

impl<'r> Flash<&'r CookieJar<'r>>

pub fn into_inner(self) -> (String, String)

Returns a tuple of (kind, message), consuming self.

pub fn kind(&self) -> &str

Returns the kind of this message.

pub fn message(&self) -> &str

Returns the message contents of this message.

Trait Implementations

impl<R: Debug> Debug for Flash<R>

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

Formats the value using the given formatter.

impl<'r, 'o: 'r, R: Responder<'r, 'o>> Responder<'r, 'o> for Flash<R>

Sets the message cookie and then uses the wrapped responder to complete the response. In other words, simply sets a cookie and delegates the rest of the response handling to the wrapped responder. As a result, the Outcome of the response is the Outcome of the wrapped Responder.

fn respond_to(self, req: &'r Request<'_>) -> Result<'o>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.