State

Struct State 

Source
pub struct State<T>(pub Arc<T>);
Expand description

Extractor for shared application state.

Use this to access data that’s shared across all connections, such as:

  • Database connection pools
  • Configuration
  • Caches
  • Connection managers

§Type Parameter

The generic parameter T should be wrapped in Arc since state is shared.

§Examples

§Accessing Connection Manager

use wsforge::prelude::*;
use std::sync::Arc;

async fn broadcast_handler(
    msg: Message,
    State(manager): State<Arc<ConnectionManager>>,
) -> Result<()> {
    manager.broadcast(msg);
    Ok(())
}

§Custom State Type

use wsforge::prelude::*;
use std::sync::Arc;

struct AppConfig {
    max_message_size: usize,
    rate_limit: u32,
}

async fn handler(State(config): State<Arc<AppConfig>>) -> Result<String> {
    Ok(format!("Max message size: {}", config.max_message_size))
}

Tuple Fields§

§0: Arc<T>

Trait Implementations§

Source§

impl<T: Send + Sync + 'static> FromMessage for State<T>

Source§

fn from_message<'life0, 'life1, 'life2, 'life3, 'async_trait>( _message: &'life0 Message, _conn: &'life1 Connection, state: &'life2 AppState, _extensions: &'life3 Extensions, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Extracts Self from the message and context. Read more

Auto Trait Implementations§

§

impl<T> Freeze for State<T>

§

impl<T> RefUnwindSafe for State<T>
where T: RefUnwindSafe,

§

impl<T> Send for State<T>
where T: Sync + Send,

§

impl<T> Sync for State<T>
where T: Sync + Send,

§

impl<T> Unpin for State<T>

§

impl<T> UnwindSafe for State<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more