Struct State 

pub struct State<S: Clone + Send + Sync + 'static>(pub S);

Extractor for state in handlers

When a cling program gets executed with a state of type S. The state can be accessed via this extractor in any handler.

Type S must implement Clone as it gets cloned every time this extractor runs.

Example:

use cling::prelude::*;

#[derive(Collect, ValueEnum, Debug, Clone)]
pub enum Colors {
    Red,
    Green,
    Blue,
}

#[derive(Clone, Debug)]
struct Database {
    _data: String,
}

async fn init(
    State(database): State<Database>,
    colors: &Option<Vec<Colors>>,
) {
    println!( ">> Hello world! color: {:?}, database: {:?}", colors, database);
}

Tuple Fields

0: S

Trait Implementations

impl<S: Clone + Clone + Send + Sync + 'static> Clone for State<S>

fn clone(&self) -> State<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + Clone + Send + Sync + 'static> Debug for State<S>

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

Formats the value using the given formatter.

impl<S: Hash + Clone + Send + Sync + 'static> Hash for State<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: Ord + Clone + Send + Sync + 'static> Ord for State<S>

fn cmp(&self, other: &State<S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq + Clone + Send + Sync + 'static> PartialEq for State<S>

fn eq(&self, other: &State<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: PartialOrd + Clone + Send + Sync + 'static> PartialOrd for State<S>

fn partial_cmp(&self, other: &State<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Eq + Clone + Send + Sync + 'static> Eq for State<S>

impl<S: Clone + Send + Sync + 'static> StructuralPartialEq for State<S>