Struct direkuta::State

pub struct State { /* private fields */ }

A wrapper around IndexMap<TypeId, Any>, used to store server state.

Stored state cannot be dynamically created and must be static.

Implementations

impl State

pub fn new() -> Self

Constructs a new State.

Examples

let state = State::new();

pub fn set<T: Any + Send + Sync + 'static>(&mut self, ctx: T)

Sets the value of whatever type is passed.

Please note that you cannot have two states of the same types, one will overwrite the other.

Examples

let mut state = State::new();

state.set(String::from("Hello World!"));

pub fn try_get<T: Any + Send + Sync + 'static>(&self) -> Option<&T>

Attempt to get a value based on type.

Use this if you are not sure if the type exists.

Examples

let mut state = State::new();

state.set(String::from("Hello World!"));

match state.try_get::<String>() {
    Some(s) => {
        println!("{}", s);
    },
    None => {
        println!("String not found in state");
    },
}

pub fn get_err<T: Any + Send + Sync + 'static>(&self) -> Result<&T, DireError>

Attempt to get a value based on type.

Use this if you are not sure if the type exists and want an Result instead of Option.

Examples

let mut state = State::new();

state.set(String::from("Hello World!"));

match state.get_err::<String>() {
    Ok(s) => {
        println!("{}", s);
    },
    Err(e) => {
        println!("String not found in state");
    },
}

pub fn get<T: Any + Send + Sync + 'static>(&self) -> &T

Get a value based on type.

This is a wrapper around try_get.

Examples

let mut state = State::new();

state.set(String::from("Hello World!"));

println!("{}", state.get::<String>());

Panics

If the key does not exist the function will panic.

If you do not know if the type exists use try_get.

Trait Implementations

impl Default for State

fn default() -> Self

Returns the “default value” for a type.