Skip to content

Commit c1112b8

Browse files
committed
docs: clarify connect wait mode on Windows
1 parent 27992f6 commit c1112b8

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

src/local_socket/stream/options.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,13 @@ impl<'n> ConnectOptions<'n> {
7676
/// | Deferred | 2 | 1 |
7777
///
7878
/// ### Windows
79-
/// Has no effect, as attempting to connect to an overloaded named pipe will immediately
80-
/// return an error.
79+
/// `WaitMode::Timeout` has no effect in that attempting to connect to an overloaded named
80+
/// pipe will always return an error as soon as possible. If the named pipe is across the
81+
/// network, this may entail blocking on network activity for a duration that exceeds the
82+
/// specified timeout.
83+
///
84+
/// `WaitMode::Deferred` is not supported, and an error will be returned by `connect_*` if it
85+
/// is used.
8186
#[must_use = builder_must_use!()]
8287
#[inline(always)]
8388
pub fn wait_mode(mut self, wait_mode: ConnectWaitMode) -> Self {

0 commit comments

Comments
 (0)