Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions src/preamble.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
14 changes: 8 additions & 6 deletions src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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::<MyPreamble>();
/// # struct MyPreamble;
/// let server = WireframeServer::new(factory).with_preamble::<MyPreamble>();
/// ```
#[must_use]
pub fn with_preamble<P>(self) -> WireframeServer<F, P>
Expand Down Expand Up @@ -367,10 +368,11 @@ async fn worker_task<F, T>(
///
/// ```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;
/// # }
Expand Down
Loading