Skip to content
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

Inotify::read_events handles only a buffer's worth of events. #157

Merged
merged 1 commit into from
Nov 5, 2020
+5 −5
Merged

Inotify::read_events handles only a buffer's worth of events. #157

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
10 changes: 5 additions & 5 deletions src/inotify.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,12 +295,12 @@ impl Inotify {
result
}

/// Returns any available events
/// Returns one buffer's worth of available events
///
/// Returns an iterator over all events that are currently available. If no
/// events are available, an iterator is still returned. If you need a
/// method that will block until at least one event is available, please
/// consider [`read_events_blocking`].
/// Reads as many events as possible into `buffer`, and returns an iterator
/// over them. If no events are available, an iterator is still returned. If
/// you need a method that will block until at least one event is available,
/// please consider [`read_events_blocking`].
///
/// Please note that inotify will merge identical unread events into a
/// single event. This means this method can not be used to count the number
Expand Down