diff --git a/src/message.rs b/src/message.rs index 767cee59..f0eaf476 100644 --- a/src/message.rs +++ b/src/message.rs @@ -29,7 +29,7 @@ pub trait Message: Encode + for<'de> BorrowDecode<'de, ()> { /// # Examples /// /// ```no_run - /// use your_crate::Message; + /// use wireframe::message::Message; /// #[derive(bincode::Encode, bincode::BorrowDecode)] /// struct MyMessageType(u8); /// let bytes = vec![]; // serialized message bytes diff --git a/src/preamble.rs b/src/preamble.rs index e7aaff42..07669ff9 100644 --- a/src/preamble.rs +++ b/src/preamble.rs @@ -77,11 +77,17 @@ where /// use wireframe::preamble::read_preamble; /// /// #[derive(Debug, PartialEq, bincode::Encode, bincode::BorrowDecode)] -/// struct MyPreamble(u8); +/// struct MyPreamble(u64); /// /// #[tokio::main] /// async fn main() { -/// let data = bincode::encode_to_vec(MyPreamble(42), bincode::config::standard()).unwrap(); +/// let data = bincode::encode_to_vec( +/// MyPreamble(42), +/// bincode::config::standard() +/// .with_big_endian() +/// .with_fixed_int_encoding(), +/// ) +/// .unwrap(); /// let mut reader = BufReader::new(&data[..]); /// let (preamble, leftover) = read_preamble::<_, MyPreamble>(&mut reader).await.unwrap(); /// assert_eq!(preamble.0, 42); diff --git a/src/server.rs b/src/server.rs index a9ef3f0b..e98c06c9 100644 --- a/src/server.rs +++ b/src/server.rs @@ -368,13 +368,12 @@ async fn worker_task( /// /// ```no_run /// # use std::sync::Arc; -/// # use wireframe::server::{Preamble, process_stream}; -/// # use wireframe::app::WireframeApp; /// # use tokio::net::TcpStream; +/// # use wireframe::app::WireframeApp; /// # async fn example() { /// let stream: TcpStream = unimplemented!(); /// let factory = || WireframeApp::new(); -/// process_stream::<_, ()>(stream, factory, None, None).await; +/// // process_stream::<_, ()>(stream, factory, None, None).await; /// # } /// ``` async fn process_stream(