Skip to content

Commit

Permalink
Improve poll_finish documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jean-airoldie authored and djc committed Mar 17, 2024
1 parent 5dd70af commit a100fc7
Showing 1 changed file with 0 additions and 6 deletions.
6 changes: 0 additions & 6 deletions quinn/src/send_stream.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,6 @@ impl SendStream {
///
/// No new data may be written after calling this method. Completes when the peer has
/// acknowledged all sent data, retransmitting data as needed.
///
/// On success, return Poll::Ready(Ok(())).
///
/// If the stream is not ready for writing, the method returns Poll::Pending and arranges
/// for the current task (via cx.waker().wake_by_ref()) to receive a notification when the
/// stream becomes writable or is closed.
pub fn poll_finish(&mut self, cx: &mut Context) -> Poll<Result<(), WriteError>> {
let mut conn = self.conn.state.lock("poll_finish");
if self.is_0rtt {
Expand Down

0 comments on commit a100fc7

Please sign in to comment.