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
2 changes: 1 addition & 1 deletion src/message.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 8 additions & 2 deletions src/preamble.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
5 changes: 2 additions & 3 deletions src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -368,13 +368,12 @@ async fn worker_task<F, T>(
///
/// ```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<F, T>(
Expand Down