Skip to content

Commit 0b6b1b4

Browse files
committed
Update prefer_socket option docs
1 parent a565767 commit 0b6b1b4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/conn/opts.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ pub struct Opts {
6464
///
6565
/// Will reconnect via socket (or named pipe on windows) after TCP
6666
/// connection to `127.0.0.1` if `true`.
67+
///
68+
/// Will fall back to TCP on error. Use `socket` option to enforce socket connection.
6769
prefer_socket: bool,
6870

6971
/// Whether to enable `TCP_NODELAY` (defaults to `true`).
@@ -193,6 +195,8 @@ impl Opts {
193195
///
194196
/// Will reconnect via socket (or named pipe on windows) after TCP connection
195197
/// to `127.0.0.1` if `true`.
198+
///
199+
/// Will fall back to TCP on error. Use `socket` option to enforce socket connection.
196200
pub fn get_prefer_socket(&self) -> bool {
197201
self.prefer_socket
198202
}
@@ -406,6 +410,8 @@ impl OptsBuilder {
406410
///
407411
/// Will reconnect via socket (on named pipe on windows) after TCP connection
408412
/// to `127.0.0.1` if `true`.
413+
///
414+
/// Will fall back to TCP on error. Use `socket` option to enforce socket connection.
409415
pub fn prefer_socket(&mut self, prefer_socket: bool) -> &mut Self {
410416
self.opts.prefer_socket = prefer_socket;
411417
self

0 commit comments

Comments
 (0)