Struct socketioxide::extract::State

pub struct State<T>(pub T);

Available on crate feature state only.

An Extractor that contains a Clone of a state previously set with SocketIoBuilder::with_state. It implements std::ops::Deref to access the inner type so you can use it as a normal reference.

The specified state type must be the same as the one set with SocketIoBuilder::with_state. If it is not the case, the handler won’t be called and an error log will be print if the tracing feature is enabled.

The state is shared between the entire socket.io app context.

Example

#[derive(Default, Clone)]
struct MyAppData {
    user_cnt: Arc<AtomicUsize>,
}
impl MyAppData {
    fn add_user(&self) {
        self.user_cnt.fetch_add(1, Ordering::SeqCst);
    }
    fn rm_user(&self) {
        self.user_cnt.fetch_sub(1, Ordering::SeqCst);
    }
}
let (_, io) = SocketIo::builder().with_state(MyAppData::default()).build_svc();
io.ns("/", |socket: SocketRef, state: State<MyAppData>| {
    state.add_user();
    println!("User count: {}", state.user_cnt.load(Ordering::SeqCst));
});

Tuple Fields

0: T

Trait Implementations

impl<T> Deref for State<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for State<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<A: Adapter, T: Clone + Send + Sync + 'static> FromConnectParts<A> for State<T>

type Error = StateNotFound<T>

The error type returned by the extractor

fn from_connect_parts( s: &Arc<Socket<A>>, _: &Option<String>, ) -> Result<Self, StateNotFound<T>>

Extract the arguments from the connect event. If it fails, the handler is not called

impl<A: Adapter, T: Clone + Send + Sync + 'static> FromDisconnectParts<A> for State<T>

type Error = StateNotFound<T>

The error type returned by the extractor

fn from_disconnect_parts( s: &Arc<Socket<A>>, _: DisconnectReason, ) -> Result<Self, StateNotFound<T>>

Extract the arguments from the disconnect event. If it fails, the handler is not called

impl<A: Adapter, T: Clone + Send + Sync + 'static> FromMessageParts<A> for State<T>

type Error = StateNotFound<T>

The error type returned by the extractor

fn from_message_parts( s: &Arc<Socket<A>>, _: &mut Value, _: &mut Vec<Bytes>, _: &Option<i64>, ) -> Result<Self, StateNotFound<T>>

Extract the arguments from the message event. If it fails, the handler is not called.