feat(socketio/state): StateCell alias

socketioxide/src/client.rs

@@ -24,11 +24,11 @@ pub struct Client<A: Adapter> {
     pub(crate) config: Arc<SocketIoConfig>,
     ns: RwLock<HashMap<Cow<'static, str>, Arc<Namespace<A>>>>,
 
-    state: Arc<dyn std::any::Any + Send + Sync>,
+    state: StateCell,
 }
 
 impl<A: Adapter> Client<A> {
-    pub fn new(config: Arc<SocketIoConfig>, state: Arc<dyn std::any::Any + Send + Sync>) -> Self {
+    pub fn new(config: Arc<SocketIoConfig>, state: StateCell) -> Self {
         Self {
             config,
             ns: RwLock::new(HashMap::new()),

socketioxide/src/handler/connect.rs

@@ -63,12 +63,7 @@ use super::MakeErasedHandler;
 /// A Type Erased [`ConnectHandler`] so it can be stored in a HashMap
 pub(crate) type BoxedConnectHandler<A> = Box<dyn ErasedConnectHandler<A>>;
 pub(crate) trait ErasedConnectHandler<A: Adapter>: Send + Sync + 'static {
-    fn call(
-        &self,
-        s: Arc<Socket<A>>,
-        auth: Option<String>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
-    );
+    fn call(&self, s: Arc<Socket<A>>, auth: Option<String>, state: &StateCell);
 }
 
 impl<A: Adapter, T, H> MakeErasedHandler<H, A, T>
@@ -87,12 +82,7 @@ where
     T: Send + Sync + 'static,
 {
     #[inline(always)]
-    fn call(
-        &self,
-        s: Arc<Socket<A>>,
-        auth: Option<String>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
-    ) {
+    fn call(&self, s: Arc<Socket<A>>, auth: Option<String>, state: &StateCell) {
         self.handler.call(s, auth, state);
     }
 }
@@ -112,7 +102,7 @@ pub trait FromConnectParts<A: Adapter>: Sized {
     fn from_connect_parts(
         s: &Arc<Socket<A>>,
         auth: &Option<String>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, Self::Error>;
 }
 
@@ -123,12 +113,7 @@ pub trait FromConnectParts<A: Adapter>: Sized {
 /// * See the [`extract`](super::extract) module doc for more details on available extractors.
 pub trait ConnectHandler<A: Adapter, T>: Send + Sync + 'static {
     /// Call the handler with the given arguments.
-    fn call(
-        &self,
-        s: Arc<Socket<A>>,
-        auth: Option<String>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
-    );
+    fn call(&self, s: Arc<Socket<A>>, auth: Option<String>, state: &StateCell);
 
     #[doc(hidden)]
     fn phantom(&self) -> std::marker::PhantomData<T> {
@@ -159,7 +144,7 @@ macro_rules! impl_handler_async {
                 &self,
                 s: Arc<Socket<A>>,
                 auth: Option<String>,
-                state: &Arc<dyn std::any::Any + Send + Sync>)
+                state: &StateCell)
             {
                 $(
                     let $ty = match $ty::from_connect_parts(&s, &auth,  state) {
@@ -195,7 +180,7 @@ macro_rules! impl_handler {
                 &self,
                 s: Arc<Socket<A>>,
                 auth: Option<String>,
-                state: &Arc<dyn std::any::Any + Send + Sync>)
+                state: &StateCell)
             {
                 $(
                     let $ty = match $ty::from_connect_parts(&s, &auth,  state) {

socketioxide/src/handler/extract.rs

@@ -119,7 +119,7 @@ where
     fn from_connect_parts(
         _: &Arc<Socket<A>>,
         auth: &Option<String>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Self::Error> {
         auth.as_ref()
             .map(|a| serde_json::from_str::<T>(a))
@@ -138,7 +138,7 @@ where
         v: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Self::Error> {
         upwrap_array(v);
         serde_json::from_value(v.clone()).map(Data)
@@ -157,7 +157,7 @@ where
     fn from_connect_parts(
         _: &Arc<Socket<A>>,
         auth: &Option<String>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         let v: Result<T, serde_json::Error> = auth
             .as_ref()
@@ -177,7 +177,7 @@ where
         v: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         upwrap_array(v);
         Ok(TryData(serde_json::from_value(v.clone())))
@@ -191,7 +191,7 @@ impl<A: Adapter> FromConnectParts<A> for SocketRef<A> {
     fn from_connect_parts(
         s: &Arc<Socket<A>>,
         _: &Option<String>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(SocketRef(s.clone()))
     }
@@ -203,7 +203,7 @@ impl<A: Adapter> FromMessageParts<A> for SocketRef<A> {
         _: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(SocketRef(s.clone()))
     }
@@ -248,7 +248,7 @@ impl<A: Adapter> FromMessage<A> for Bin {
         _: serde_json::Value,
         bin: Vec<Vec<u8>>,
         _: Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(Bin(bin))
     }
@@ -269,7 +269,7 @@ impl<A: Adapter> FromMessageParts<A> for AckSender<A> {
         _: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         ack_id: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(Self::new(s.clone(), *ack_id))
     }
@@ -311,7 +311,7 @@ impl<A: Adapter> FromConnectParts<A> for crate::ProtocolVersion {
     fn from_connect_parts(
         s: &Arc<Socket<A>>,
         _: &Option<String>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(s.protocol())
     }
@@ -323,7 +323,7 @@ impl<A: Adapter> FromMessageParts<A> for crate::ProtocolVersion {
         _: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(s.protocol())
     }
@@ -340,7 +340,7 @@ impl<A: Adapter> FromConnectParts<A> for crate::TransportType {
     fn from_connect_parts(
         s: &Arc<Socket<A>>,
         _: &Option<String>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(s.transport_type())
     }
@@ -352,7 +352,7 @@ impl<A: Adapter> FromMessageParts<A> for crate::TransportType {
         _: &mut serde_json::Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
+        _: &StateCell,
     ) -> Result<Self, Infallible> {
         Ok(s.transport_type())
     }
@@ -411,10 +411,12 @@ impl<A: Adapter> FromDisconnectParts<A> for DisconnectReason {
 ///     println!("User count: {}", state.user_cnt());
 /// });
 pub struct State<T: Send + Sync + 'static> {
-    /// The state must be in an `Arc` because it is impossible to have lifetime on the extracted data.
-    state: Arc<dyn std::any::Any + Send + Sync>,
+    state: StateCell,
     _marker: std::marker::PhantomData<T>,
 }
+/// The state must be in an `Arc` because it is impossible to have lifetime on the extracted data.
+pub type StateCell = Arc<dyn std::any::Any + Send + Sync>;
+
 impl<T: Send + Sync + 'static> std::ops::Deref for State<T> {
     type Target = T;
     fn deref(&self) -> &Self::Target {
@@ -442,7 +444,7 @@ impl<A: Adapter, T: Send + Sync + 'static> FromConnectParts<A> for State<T> {
     fn from_connect_parts(
         _: &Arc<Socket<A>>,
         _: &Option<String>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, StateNotFound> {
         // SAFETY: This check is mandatory because later when the extractor is used,
         // the state type is dereferenced without any checks
@@ -462,7 +464,7 @@ impl<A: Adapter, T: Send + Sync + 'static> FromMessageParts<A> for State<T> {
         _: &mut Value,
         _: &mut Vec<Vec<u8>>,
         _: &Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, StateNotFound> {
         if !state.is::<T>() {
             return Err(StateNotFound);
@@ -494,14 +496,14 @@ mod tests {
     fn extract_state_not_found() {
         struct A;
         struct B;
-        let b = Arc::new(B) as Arc<dyn std::any::Any + Send + Sync>;
+        let b = Arc::new(B) as StateCell;
         State::<A>::from_connect_parts(&new_socket(), &None, &b).unwrap_err();
     }
 
     #[test]
     fn extract_state_found() {
         struct A;
-        let a = Arc::new(A) as Arc<dyn std::any::Any + Send + Sync>;
+        let a = Arc::new(A) as StateCell;
         State::<A>::from_connect_parts(&new_socket(), &None, &a).unwrap();
     }
 }

socketioxide/src/handler/message.rs

@@ -91,7 +91,7 @@ pub(crate) trait ErasedMessageHandler<A: Adapter>: Send + Sync + 'static {
         v: Value,
         p: Vec<Vec<u8>>,
         ack_id: Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     );
 }
 
@@ -114,7 +114,7 @@ pub trait MessageHandler<A: Adapter, T>: Send + Sync + 'static {
         v: Value,
         p: Vec<Vec<u8>>,
         ack_id: Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     );
 
     #[doc(hidden)]
@@ -147,7 +147,7 @@ where
         v: Value,
         p: Vec<Vec<u8>>,
         ack_id: Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) {
         self.handler.call(s, v, p, ack_id, state);
     }
@@ -188,7 +188,7 @@ pub trait FromMessageParts<A: Adapter>: Sized {
         v: &mut Value,
         p: &mut Vec<Vec<u8>>,
         ack_id: &Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, Self::Error>;
 }
 
@@ -214,7 +214,7 @@ pub trait FromMessage<A: Adapter, M = private::ViaRequest>: Sized {
         v: Value,
         p: Vec<Vec<u8>>,
         ack_id: Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, Self::Error>;
 }
 
@@ -230,7 +230,7 @@ where
         mut v: Value,
         mut p: Vec<Vec<u8>>,
         ack_id: Option<i64>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<Self, Self::Error> {
         Self::from_message_parts(&s, &mut v, &mut p, &ack_id, state)
     }
@@ -243,14 +243,7 @@ where
     Fut: Future<Output = ()> + Send + 'static,
     A: Adapter,
 {
-    fn call(
-        &self,
-        _: Arc<Socket<A>>,
-        _: Value,
-        _: Vec<Vec<u8>>,
-        _: Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
-    ) {
+    fn call(&self, _: Arc<Socket<A>>, _: Value, _: Vec<Vec<u8>>, _: Option<i64>, _: &StateCell) {
         let fut = (self.clone())();
         tokio::spawn(fut);
     }
@@ -262,14 +255,7 @@ where
     F: FnOnce() + Send + Sync + Clone + 'static,
     A: Adapter,
 {
-    fn call(
-        &self,
-        _: Arc<Socket<A>>,
-        _: Value,
-        _: Vec<Vec<u8>>,
-        _: Option<i64>,
-        _: &Arc<dyn std::any::Any + Send + Sync>,
-    ) {
+    fn call(&self, _: Arc<Socket<A>>, _: Value, _: Vec<Vec<u8>>, _: Option<i64>, _: &StateCell) {
         (self.clone())();
     }
 }
@@ -293,7 +279,7 @@ macro_rules! impl_async_handler {
             mut v: Value,
             mut p: Vec<Vec<u8>>,
             ack_id: Option<i64>,
-            state: &Arc<dyn std::any::Any + Send + Sync>)
+            state: &StateCell)
         {
                 $(
                     let $ty = match $ty::from_message_parts(&s, &mut v, &mut p, &ack_id,  state) {
@@ -338,7 +324,7 @@ macro_rules! impl_handler {
                 mut v: Value,
                 mut p: Vec<Vec<u8>>,
                 ack_id: Option<i64>,
-                state: &Arc<dyn std::any::Any + Send + Sync>)
+                state: &StateCell)
             {
                 $(
                     let $ty = match $ty::from_message_parts(&s, &mut v, &mut p, &ack_id,  state) {

socketioxide/src/io.rs

@@ -57,7 +57,7 @@ pub struct SocketIoBuilder<A: Adapter = LocalAdapter> {
     config: SocketIoConfig,
     engine_config_builder: EngineIoConfigBuilder,
     adapter: std::marker::PhantomData<A>,
-    state: Arc<dyn std::any::Any + Send + Sync>,
+    state: StateCell,
 }
 
 impl<A: Adapter> SocketIoBuilder<A> {

socketioxide/src/layer.rs

@@ -60,7 +60,7 @@ impl<A: Adapter> Clone for SocketIoLayer<A> {
 impl<A: Adapter> SocketIoLayer<A> {
     pub(crate) fn from_config(
         config: Arc<SocketIoConfig>,
-        state: Arc<dyn std::any::Any + Send + Sync>,
+        state: StateCell,
     ) -> (Self, Arc<Client<A>>) {
         let client = Arc::new(Client::new(config.clone(), state));
         let layer = Self {

socketioxide/src/ns.rs

@@ -43,7 +43,7 @@ impl<A: Adapter> Namespace<A> {
         esocket: Arc<engineioxide::Socket<SocketData>>,
         auth: Option<String>,
         config: Arc<SocketIoConfig>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
+        state: &StateCell,
     ) -> Result<(), serde_json::Error> {
         let socket: Arc<Socket<A>> = Socket::new(sid, self.clone(), esocket.clone(), config).into();
 
@@ -73,12 +73,7 @@ impl<A: Adapter> Namespace<A> {
         self.sockets.read().unwrap().values().any(|s| s.id == sid)
     }
 
-    pub fn recv(
-        &self,
-        sid: Sid,
-        packet: PacketData<'_>,
-        state: &Arc<dyn std::any::Any + Send + Sync>,
-    ) -> Result<(), Error> {
+    pub fn recv(&self, sid: Sid, packet: PacketData<'_>, state: &StateCell) -> Result<(), Error> {
         match packet {
             PacketData::Connect(_) => unreachable!("connect packets should be handled before"),
             PacketData::ConnectError => Err(Error::InvalidPacketType),

socketioxide/src/service.rs

@@ -77,7 +77,7 @@ impl<A: Adapter, S: Clone> SocketIoService<S, A> {
     pub(crate) fn with_config_inner(
         inner: S,
         config: Arc<SocketIoConfig>,
-        state: Arc<dyn std::any::Any + Send + Sync>,
+        state: StateCell,
     ) -> (Self, Arc<Client<A>>) {
         let engine_config = config.engine_config.clone();
         let client = Arc::new(Client::new(config, state));