From 2c3c6ee606fc18c91ac5dd99b02a933a50f45cb1 Mon Sep 17 00:00:00 2001 From: John Nunley Date: Tue, 3 Dec 2024 17:23:28 -0800 Subject: [PATCH] docs: Sync README.md with crate docs Closes #212 Signed-off-by: John Nunley --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 840c6ad..b34ae0c 100644 --- a/README.md +++ b/README.md @@ -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