Skip to content

Commit a0a57d8

Browse files
committed
docs: Sync README.md with crate docs
Closes #212 Signed-off-by: John Nunley <[email protected]>
1 parent 033e3a8 commit a0a57d8

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,15 @@ Supported platforms:
1919
- [poll](https://en.wikipedia.org/wiki/Poll_(Unix)): VxWorks, Fuchsia, HermitOS, other Unix systems
2020
- [IOCP](https://learn.microsoft.com/en-us/windows/win32/fileio/i-o-completion-ports): Windows, Wine (version 7.13+)
2121

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

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

29+
[`PollMode`]: https://docs.rs/polling/latest/polling/enum.PollMode.html
30+
2731
## Examples
2832

2933
```rust,no_run

0 commit comments

Comments
 (0)