Struct salvo::prelude::Depot

pub struct Depot { /* private fields */ }

Depot if for store temp data of current request. Each handler can read or write data to it.

Example

use salvo_core::prelude::*;

#[handler]
async fn set_user(req: &mut Request, depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
    depot.insert("user", "client");
    ctrl.call_next(req, depot, res).await;
}
#[handler]
async fn hello_world(depot: &mut Depot) -> String {
    format!("Hello {}", depot.get::<&str>("user").map(|s|*s).unwrap_or_default())
}
#[tokio::main]
async fn main() {
    let router = Router::new().hoop(set_user).handle(hello_world);
    Server::new(TcpListener::bind("127.0.0.1:7878")).serve(router).await;
}

Implementations

impl Depot

pub fn new() -> Depot

Creates an empty Depot.

The depot is initially created with a capacity of 0, so it will not allocate until it is first inserted into.

pub fn inner(
    &self
) -> &HashMap<String, Box<dyn Any + Send + 'static, Global>, RandomState>

Get reference to depot inner map.

pub fn with_capacity(capacity: usize) -> Depot

Creates an empty Depot with the specified capacity.

The depot will be able to hold at least capacity elements without reallocating. If capacity is 0, the depot will not allocate.

pub fn capacity(&self) -> usize

Returns the number of elements the depot can hold without reallocating.

pub fn inject<V>(&mut self, value: V)where
    V: Any + Send,

Inject a value into the depot.

pub fn obtain<T>(&self) -> Option<&T>where
    T: Any + Send,

Obtain a reference to a value previous inject to the depot.

pub fn insert<K, V>(&mut self, key: K, value: V)where
    K: Into<String>,
    V: Any + Send,

Inserts a key-value pair into the depot.

pub fn contains_key(&self, key: &str) -> bool

Check is there a value stored in depot with this key.

pub fn get<V>(&self, key: &str) -> Option<&V>where
    V: Any + Send,

Immutably borrows value from depot, returing none if value is not present in depot.

pub fn get_mut<V>(&mut self, key: &str) -> Option<&mut V>where
    V: Any + Send,

Mutably borrows value from depot, returing none if value is not present in depot.

pub fn remove<V>(&mut self, key: &str) -> Option<V>where
    V: Any + Send,

Take value from depot container.

pub fn transfer(&mut self) -> Depot

Transfer all data to a new instance.

Trait Implementations

impl BasicAuthDepotExt for Depot

fn basic_auth_username(&self) -> Option<&String>

Get basic auth username reference.

impl CsrfDepotExt for Depot

fn csrf_token(&self) -> Option<&str>

Gets the CSRF token for inclusion in an HTTP request header, a query parameter, or a form field.

fn csrf_header_name(&self) -> Option<&str>

Gets the name of the header in which to returns the CSRF token, if the CSRF token is being returned in a header.

fn csrf_query_param(&self) -> Option<&str>

Gets the name of the query param in which to returns the CSRF token, if the CSRF token is being returned in a query param.

fn csrf_field_name(&self) -> Option<&str>

Gets the name of the form field in which to returns the CSRF token, if the CSRF token is being returned in a form field.

impl Debug for Depot

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

Formats the value using the given formatter.

impl Default for Depot

fn default() -> Depot

Returns the “default value” for a type.

impl JwtAuthDepotExt for Depot

fn jwt_auth_token(&self) -> Option<&String>

get jwt auth token reference from depot.

fn jwt_auth_data<C>(&self) -> Option<&TokenData<C>>where
    C: 'static + DeserializeOwned + Send + Sync,

get jwt auth decoded data from depot.

fn jwt_auth_state(&self) -> JwtAuthState

get jwt auth state from depot.

impl SessionDepotExt for Depot

fn set_session(&mut self, session: Session)

Set session

fn take_session(&mut self) -> Option<Session>

Take session

fn session(&self) -> Option<&Session>

Get session reference

fn session_mut(&mut self) -> Option<&mut Session>

Get session mutable reference