diff --git a/src/message.rs b/src/message.rs index c0933c33..767cee59 100644 --- a/src/message.rs +++ b/src/message.rs @@ -28,10 +28,12 @@ pub trait Message: Encode + for<'de> BorrowDecode<'de, ()> { /// /// # Examples /// - /// ``` + /// ```no_run /// use your_crate::Message; - /// let bytes = /* some valid serialised message bytes */; - /// let (msg, consumed) = MyMessageType::from_bytes(&bytes).unwrap(); + /// #[derive(bincode::Encode, bincode::BorrowDecode)] + /// struct MyMessageType(u8); + /// let bytes = vec![]; // serialized message bytes + /// let (_msg, consumed) = MyMessageType::from_bytes(&bytes).unwrap(); /// assert!(consumed <= bytes.len()); /// ``` fn from_bytes(bytes: &[u8]) -> Result<(Self, usize), DecodeError> diff --git a/src/preamble.rs b/src/preamble.rs index cd94093a..e7aaff42 100644 --- a/src/preamble.rs +++ b/src/preamble.rs @@ -74,9 +74,9 @@ where /// /// ``` /// use tokio::io::BufReader; -/// use bincode::BorrowDecode; +/// use wireframe::preamble::read_preamble; /// -/// #[derive(Debug, PartialEq, bincode::BorrowDecode)] +/// #[derive(Debug, PartialEq, bincode::Encode, bincode::BorrowDecode)] /// struct MyPreamble(u8); /// /// #[tokio::main] diff --git a/src/server.rs b/src/server.rs index ab674df9..a9ef3f0b 100644 --- a/src/server.rs +++ b/src/server.rs @@ -92,11 +92,12 @@ where /// # Examples /// /// ```no_run - /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// # use wireframe::server::WireframeServer; + /// # use wireframe::app::WireframeApp; + /// # let factory = || WireframeApp::new().unwrap(); /// #[derive(bincode::Decode)] - /// struct MyPreamble; - /// let server = WireframeServer::new(|| WireframeApp::default()) - /// .with_preamble::(); + /// # struct MyPreamble; + /// let server = WireframeServer::new(factory).with_preamble::(); /// ``` #[must_use] pub fn with_preamble

(self) -> WireframeServer @@ -367,10 +368,11 @@ async fn worker_task( /// /// ```no_run /// # use std::sync::Arc; -/// # use mycrate::{process_stream, WireframeApp, Preamble}; +/// # use wireframe::server::{Preamble, process_stream}; +/// # use wireframe::app::WireframeApp; /// # use tokio::net::TcpStream; /// # async fn example() { -/// let stream: TcpStream = /* ... */; +/// let stream: TcpStream = unimplemented!(); /// let factory = || WireframeApp::new(); /// process_stream::<_, ()>(stream, factory, None, None).await; /// # }