Skip to content
This repository has been archived by the owner on Apr 11, 2020. It is now read-only.

add note about message being popped #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions src/recv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,8 @@ impl Receiver<Unconnected> {
/// Checks for a pending OSC packet and returns `Ok(Some)` if there is one waiting along with
/// the source address.
///
/// When called, this method will pop a message from the receiver's queue.
///
/// If there are no packets waiting (or if the inner UDP socket's `recv` method returns an
/// error) this will immediately return with `Ok(None)`.
///
Expand Down