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

Sync README.md with crate docs #222

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Sync README.md with crate docs #222

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: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@ Supported platforms:
- [poll](https://en.wikipedia.org/wiki/Poll_(Unix)): VxWorks, Fuchsia, HermitOS, other Unix systems
- [IOCP](https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports): Windows, Wine (version 7.13+)

Polling is done in oneshot mode, which means interest in I/O events needs to be reset after
an event is delivered if we're interested in the next event of the same kind.
By default, polling is done in oneshot mode, which means interest in I/O events needs to
be re-enabled after an event is delivered if we're interested in the next event of the same
kind. However, level and edge triggered modes are also available for certain operating
systems. See the documentation of the [`PollMode`] type for more information.

Only one thread can be waiting for I/O events at a time.

[`PollMode`]: https://docs.rs/polling/latest/polling/enum.PollMode.html

## Examples

```rust,no_run
Expand Down
Loading