Clarify FragmentCollectorRead::read_frame(send_fn) closure document…

…ation (#89)
denoland · Jan 4, 2025 · e912a92 · e912a92
1 parent eadb437
commit e912a92
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/fragment.rs b/src/fragment.rs
@@ -168,6 +168,10 @@ impl<'f, S> FragmentCollectorRead<S> {
   /// Reads a WebSocket frame, collecting fragmented messages until the final frame is received and returns the completed message.
   ///
   /// Text frames payload is guaranteed to be valid UTF-8.
+  ///
+  /// # Arguments
+  ///
+  /// * `send_fn`: Closure must ensure frames are sent by write side of split WebSocket to correctly implement auto-close and auto-pong.
   pub async fn read_frame<R, E>(
     &mut self,
     send_fn: &mut impl FnMut(Frame<'f>) -> R,