Skip to content

docs: add guarantees to the read and send_datagram function #2375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

docs: add guarantees to the read and send_datagram function #2375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions quinn/src/connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,10 @@ impl Connection {
}

/// Receive an application datagram
///
/// Guarantees:
/// - Cancel-safe future
/// - First poll resolves immediately if a datagram is available
pub fn read_datagram(&self) -> ReadDatagram<'_> {
ReadDatagram {
conn: &self.0,
Expand Down Expand Up @@ -430,6 +434,10 @@ impl Connection {
///
/// Previously queued datagrams which are still unsent may be discarded to make space for this
/// datagram, in order of oldest to newest.
///
/// Guarantees:
/// - Cancel-safe future
/// - First poll resolves immediately if given datagram can be sent
pub fn send_datagram(&self, data: Bytes) -> Result<(), SendDatagramError> {
let conn = &mut *self.0.state.lock("send_datagram");
if let Some(ref x) = conn.error {
Expand Down
Loading