Struct salvo_core::prelude::Depot

pub struct Depot { /* fields omitted */ }

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

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 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 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 has<K>(&self, key: K) -> bool where
    K: Into<String>, 

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

pub fn try_borrow<K, V>(&self, key: K) -> Option<&V> where
    K: Into<String>,
    V: Any + Send, 

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

pub fn borrow<K, V>(&self, key: K) -> &V where
    K: Into<String>,
    V: Any + Send, 

Immutably borrows value from depot.

Panics

Panics if the value is currently mutably borrowed or not present in depot. For a non-panicking variant, use try_borrow.

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

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

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

Mutably borrows value from depot.

Panics

Panics if the value is currently borrowed or not present in depot. For a non-panicking variant, use try_borrow_mut.

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

Take value from depot container.

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

Take value from depot container.

Panics

Panics if the value is not present in depot container. For a non-panicking variant, use try_take.

pub fn transfer(&mut self) -> Depot

Trait Implementations

impl Debug for Depot

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

Formats the value using the given formatter.

impl Default for Depot

fn default() -> Depot

Returns the “default value” for a type.