Struct glory_core::Truck

pub struct Truck { /* private fields */ }

Truck is 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(truck: &mut Truck) {
    truck.insert("user", "client");
    ctrl.call_next(req, truck, res).await;
}
#[handler]
async fn hello(truck: &mut Truck) -> String {
    format!("Hello {}", truck.get::<&str>("user").map(|s|*s).unwrap_or_default())
}
#[tokio::main]
async fn main() {
    let router = Router::new().hoop(set_user).handle(hello);
    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

Implementations

impl Truck

pub fn new() -> Truck

Creates an empty Truck.

The truck 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>>

Get reference to truck inner map.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty Truck with the specified capacity.

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

pub fn capacity(&self) -> usize

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

pub fn inject<V: Any>(&mut self, value: V) -> &mut Self

Inject a value into the truck.

pub fn obtain<T: Any>(&self) -> Result<&T, Option<&Box<dyn Any>>>

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

Returns Err(None) if value is not present in truck. Returns Err(Some(Box<dyn Any>)) if value is present in truck but downcast failed.

pub fn obtain_mut<T: Any>( &mut self ) -> Result<&mut T, Option<&mut Box<dyn Any>>>

Obtain a mutable reference to a value previous inject to the truck.

Returns Err(None) if value is not present in truck. Returns Err(Some(Box<dyn Any>)) if value is present in truck but downcast failed.

pub fn insert<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Any,

Inserts a key-value pair into the truck.

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

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

pub fn contains<T: Any>(&self) -> bool

Check is there a value stored in truck.

pub fn get<V: Any>(&self, key: &str) -> Result<&V, Option<&Box<dyn Any>>>

Immutably borrows value from truck.

Returns Err(None) if value is not present in truck. Returns Err(Some(Box<dyn Any>)) if value is present in truck but downcast failed.

pub fn get_mut<V: Any>( &mut self, key: &str ) -> Result<&mut V, Option<&mut Box<dyn Any>>>

Mutably borrows value from truck.

Returns Err(None) if value is not present in truck. Returns Err(Some(Box<dyn Any>)) if value is present in truck but downcast failed.

pub fn remove<V: Any>(&mut self, key: &str) -> Result<V, Option<Box<dyn Any>>>

Remove value from truck and returning the value at the key if the key was previously in the truck.

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

Delete the key from truck, if the key is not present, return false.

pub fn scrape<T: Any>(&mut self) -> Result<T, Option<Box<dyn Any>>>

Remove value from truck and returning the value if the type was previously in the truck.

Trait Implementations

impl Debug for Truck

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

Formats the value using the given formatter.

impl Default for Truck

fn default() -> Truck

Returns the “default value” for a type.