Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jonas Platte <[email protected]>
  • Loading branch information
alexheretic and jplatte committed Jul 27, 2023
1 parent f4abd0d commit f7b3754
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions axum/src/extract/ws.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ impl<F> std::fmt::Debug for WebSocketUpgrade<F> {
impl<F> WebSocketUpgrade<F> {
/// The target minimum size of the write buffer to reach before writing the data
/// to the underlying stream.
///
/// The default value is 128 KiB.
///
/// If set to `0` each message will be eagerly written to the underlying stream.
Expand All @@ -164,6 +165,7 @@ impl<F> WebSocketUpgrade<F> {

/// The max size of the write buffer in bytes. Setting this can provide backpressure
/// in the case the write buffer is filling up due to write errors.
///
/// The default value is unlimited.
///
/// Note: The write buffer only builds up past [`write_buffer_size`](Self::write_buffer_size)
Expand Down

0 comments on commit f7b3754

Please sign in to comment.