Inotify::read_events handles only a buffer's worth of events. #157
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jimblandy
force-pushed
the
read-events-doc-fix
branch
2 times, most recently
from
2b8ebc4 to
15407b1
Compare
|
Thank you, @jimblandy, good catch there! I wonder if the behavior changed at one point, or if the documentation was always wrong. Oh well. |
hannobraun
requested changes
Nov 4, 2020
Fixes hannobraun#156. Change the documentation of `Inotify::read_events` to match the actual behavior: return an iterator over only as many events can fit in the supplied buffer, not over any available events. It would be possible to make `Events` behave as documented, but it would need to hold a strong reference to `fd` and a mutable reference to `buffer`, and it seems awkward. The `notify` crate's use of `read_events` is easily switched by requesting level-sensitive notification on the inotify file descriptor, which is designed for exactly this sort of situation.
jimblandy
force-pushed
the
read-events-doc-fix
branch
from
15407b1 to
a3d5f0c
Compare
hannobraun
approved these changes
Nov 5, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the documentation of
Inotify::read_eventsto match the actual behavior:return an iterator over only as many events can fit in the supplied buffer, not
over any available events. Since this is a backwards-incompatible change, bump
the crate version number to 0.9.0.
It would be possible to make
Eventsbehave as documented, but it would need tohold a strong reference to
fdand a mutable reference tobuffer, and itseems awkward. The
notifycrate's use ofread_eventsis easily switched byrequesting level-sensitive notification on the inotify file descriptor, which is
designed for exactly this sort of situation.