From 76aa5085b0548ad86e5a57771498d14597c8e1ff Mon Sep 17 00:00:00 2001 From: Leynos Date: Fri, 13 Jun 2025 23:36:42 +0100 Subject: [PATCH] Update doc examples and remove test duplication --- src/extractor.rs | 22 ---------------------- src/middleware.rs | 8 +++++--- src/server.rs | 38 ++++++++++++++++++++++++++------------ 3 files changed, 31 insertions(+), 37 deletions(-) diff --git a/src/extractor.rs b/src/extractor.rs index 6d86b839..eaf02cfe 100644 --- a/src/extractor.rs +++ b/src/extractor.rs @@ -119,25 +119,3 @@ impl std::ops::Deref for SharedState { &self.0 } } - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn advance_consumes_bytes() { - let mut payload = Payload { data: b"hello" }; - payload.advance(2); - assert_eq!(payload.data, b"llo"); - payload.advance(10); - assert!(payload.data.is_empty()); - } - - #[test] - fn remaining_reports_length() { - let mut payload = Payload { data: b"abc" }; - assert_eq!(payload.remaining(), 3); - payload.advance(1); - assert_eq!(payload.remaining(), 2); - } -} diff --git a/src/middleware.rs b/src/middleware.rs index 671735ac..83098b8b 100644 --- a/src/middleware.rs +++ b/src/middleware.rs @@ -28,12 +28,14 @@ where /// # Examples /// /// ```ignore - /// # use your_crate::{Next, Service, ServiceRequest}; + /// # use async_trait::async_trait; + /// # use wireframe::middleware::{Next, Service, ServiceRequest, ServiceResponse}; /// # struct MyService; + /// # #[async_trait] /// # impl Service for MyService { /// # type Error = std::convert::Infallible; - /// # async fn call(&self, _req: ServiceRequest) -> Result { - /// # Ok(super::ServiceResponse) + /// # async fn call(&self, _req: ServiceRequest) -> Result { + /// # Ok(ServiceResponse) /// # } /// # } /// let service = MyService; diff --git a/src/server.rs b/src/server.rs index 46054781..e1e850f0 100644 --- a/src/server.rs +++ b/src/server.rs @@ -54,6 +54,8 @@ where /// # Examples /// /// ```ignore + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// /// let server = WireframeServer::new(|| WireframeApp::default()); /// assert!(server.worker_count() >= 1); /// ``` @@ -73,7 +75,10 @@ where /// /// # Examples /// - /// ```ignore + /// ```no_run + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// + /// let factory = || WireframeApp::new().unwrap(); /// let server = WireframeServer::new(factory).workers(4); /// ``` #[must_use] @@ -84,6 +89,9 @@ where /// # Examples /// /// ```ignore + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// + /// let factory = || WireframeApp::new().unwrap(); /// let server = WireframeServer::new(factory).workers(4); /// assert_eq!(server.worker_count(), 4); /// let server = server.workers(0); @@ -102,6 +110,9 @@ where /// # Examples /// /// ```ignore + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// + /// let factory = || WireframeApp::new().unwrap(); /// let server = WireframeServer::new(factory); /// assert!(server.worker_count() >= 1); /// ``` @@ -127,8 +138,11 @@ where /// /// # Examples /// - /// ```ignore + /// ```no_run /// use std::net::SocketAddr; + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// + /// let factory = || WireframeApp::new().unwrap(); /// let server = WireframeServer::new(factory); /// let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap(); /// let server = server.bind(addr).expect("Failed to bind address"); @@ -167,16 +181,16 @@ where /// /// # Examples /// - /// ```ignore - /// # use std::net::SocketAddr; - /// # use mycrate::{WireframeServer, WireframeApp}; - /// # async fn run_server() -> std::io::Result<()> { - /// let factory = || WireframeApp::new(); - /// let server = WireframeServer::new(factory) - /// .workers(4) - /// .bind("127.0.0.1:8080".parse::().unwrap())?; - /// server.run().await - /// # } + /// ```no_run + /// use std::net::SocketAddr; + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// async fn run_server() -> std::io::Result<()> { + /// let factory = || WireframeApp::new().unwrap(); + /// let server = WireframeServer::new(factory) + /// .workers(4) + /// .bind("127.0.0.1:8080".parse::().unwrap())?; + /// server.run().await + /// } /// ``` pub async fn run(self) -> io::Result<()> { let listener = self.listener.expect("`bind` must be called before `run`");