Skip to content

Commit

Permalink
docs: Sync README.md with crate docs
Browse files Browse the repository at this point in the history
Closes #212

Signed-off-by: John Nunley <[email protected]>
  • Loading branch information
notgull committed Dec 4, 2024
1 parent 033e3a8 commit 2c3c6ee
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
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

0 comments on commit 2c3c6ee

Please sign in to comment.