From c082107fb6c67fedd5d040dc3cbcaa9a35bab02c Mon Sep 17 00:00:00 2001
From: David Pedersen <david.pdrsn@gmail.com>
Date: Mon, 30 Aug 2021 23:13:50 +0200
Subject: [PATCH] Document using `StreamExt::split` with `WebSocket` (#291)

Fixes https://github.com/tokio-rs/axum/issues/283
---
 src/extract/ws.rs | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/src/extract/ws.rs b/src/extract/ws.rs
index 8bdcb7b7..361b5dd5 100644
--- a/src/extract/ws.rs
+++ b/src/extract/ws.rs
@@ -35,6 +35,33 @@
 //! # axum::Server::bind(&"".parse().unwrap()).serve(app.into_make_service()).await.unwrap();
 //! # };
 //! ```
+//!
+//! # Read and write concurrently
+//!
+//! If you need to read and write concurrently from a [`WebSocket`] you can use
+//! [`StreamExt::split`]:
+//!
+//! ```
+//! use axum::{Error, extract::ws::{WebSocket, Message}};
+//! use futures::{sink::SinkExt, stream::{StreamExt, SplitSink, SplitStream}};
+//!
+//! async fn handle_socket(mut socket: WebSocket) {
+//!     let (mut sender, mut receiver) = socket.split();
+//!
+//!     tokio::spawn(write(sender));
+//!     tokio::spawn(read(receiver));
+//! }
+//!
+//! async fn read(receiver: SplitStream<WebSocket>) {
+//!     // ...
+//! }
+//!
+//! async fn write(sender: SplitSink<WebSocket, Message>) {
+//!     // ...
+//! }
+//! ```
+//!
+//! [`StreamExt::split`]: https://docs.rs/futures/0.3.17/futures/stream/trait.StreamExt.html#method.split
 
 use self::rejection::*;
 use super::{rejection::*, FromRequest, RequestParts};