Deprecate SharedState::new

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+- Deprecated `SharedState::new` (since 0.2.0); construct via `inner.into()`
+  instead.

README.md

@@ -32,7 +32,7 @@ connections and runs the Tokio event loop:
 WireframeServer::new(|| {
     WireframeApp::new()
         .frame_processor(MyFrameProcessor::new())
-        .app_data(SharedState::new(state.clone()))
+        .app_data(state.clone().into())
         .route(MessageType::Login, handle_login)
         .wrap(MyLoggingMiddleware::default())
 })

docs/rust-binary-router-library-design.md

@@ -624,7 +624,7 @@ WireframeApp::new()
 
 .frame_processor(MyFrameProcessor::new()) // Configure the framing logic
 
-.app_data(SharedState::new(app_state.clone())) // Shared application state
+.app_data(app_state.clone().into()) // Shared application state
 
 //.service(login_handler) // If using attribute macros and auto-discovery
 

src/extractor.rs

@@ -65,7 +65,7 @@ impl<T: Send + Sync> SharedState<T> {
     /// use wireframe::extractor::SharedState;
     ///
     /// let data = Arc::new(5u32);
-    /// let state = SharedState::new(Arc::clone(&data));
+    /// let state: SharedState<u32> = Arc::clone(&data).into();
     /// assert_eq!(*state, 5);
     /// ```
     #[must_use]
@@ -78,9 +78,10 @@ impl<T: Send + Sync> SharedState<T> {
     /// use wireframe::extractor::SharedState;
     ///
     /// let state = Arc::new(42);
-    /// let shared = SharedState::new(state.clone());
+    /// let shared: SharedState<u32> = state.clone().into();
     /// assert_eq!(*shared, 42);
     /// ```
+    #[deprecated(since = "0.2.0", note = "construct via `inner.into()` instead")]
     pub fn new(inner: Arc<T>) -> Self {
         Self(inner)
     }
@@ -112,7 +113,7 @@ impl<T: Send + Sync> std::ops::Deref for SharedState<T> {
     /// use wireframe::extractor::SharedState;
     ///
     /// let state = Arc::new(42);
-    /// let shared = SharedState::new(state.clone());
+    /// let shared: SharedState<u32> = state.clone().into();
     /// assert_eq!(*shared, 42);
     /// ```
     fn deref(&self) -> &Self::Target {