mirror of
https://github.com/openharmony/third_party_rust_mio.git
synced 2026-07-01 20:53:59 -04:00
Document the current Poll::poll timeout behaviour
This commit is contained in:
@@ -349,6 +349,10 @@ impl Poll {
|
||||
/// of Mio would automatically retry the poll call if it was interrupted
|
||||
/// (if `EINTR` was returned).
|
||||
///
|
||||
/// Currently if the `timeout` elapses without any readiness events
|
||||
/// triggering this will return `Ok(())`. However we're not guaranteeing
|
||||
/// this behaviour as this depends on the OS.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// A basic example -- establishing a `TcpStream` connection.
|
||||
|
||||
Reference in New Issue
Block a user