Provide better doc code example for UnixDatagram::bind_addr and UnixListener::bind_addr - #163580
Merged
rust-bors[bot] merged 1 commit intoOct 2, 2026
Merged
Conversation
rustbot
added
O-unix
Collaborator
|
r? @Darksonn rustbot has assigned @Darksonn. Use Why was this reviewer chosen?The reviewer was selected based on:
|
…istener::bind_addr
asder8215
force-pushed
the
unix_sockets_bind_addr_docs
branch
from
October 1, 2026 04:00
fb4cdc8 to
82366d5
Compare
Contributor
rust-bors
Bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Oct 1, 2026
…ocs, r=Darksonn Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr` The current doc code example for both [`UnixDatagram::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind_addr) and [`UnixListener::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind_addr) attempts binding to an already binded socket address. It's clear that this would always result in a `AddrInUse` error. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular `*::bind` functions (since it will return an error if we pass in a `Path` with interior nul bytes). I thought it would be better to provide an example of how to use this `UnixDatagram::bind_addr` and `UnixListener::bind_addr` via `SocketAddr::from_pathname` since that's general purpose to all platforms within the Unix family. You can verify in this rust playground how the current example (if you switch the `"path/to/socket"` argument to a tmp directory path) always result in an `AddrInUse` error. * [`UnixListener::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=153c9e3131275e9c859dfa47f1d528b6) * [`UnixDatagram::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=a6fdd5cc9c9b08b8c4a58f4c2d6b83cb)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 1, 2026
…uwer Rollup of 9 pull requests Successful merges: - #163483 (Bump bootstrap compiler to 1.100.0 beta) - #161380 (only rerun const eval in next-solver if the const actually references opaques) - #162900 (Some refactorings around metadata encoding) - #163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - #163584 ([triagebot] Ping me for debugger visualizer changes) - #162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors) - #163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - #163405 (Remove some #[linkage] options) - #163581 (do not suggest precise capturing when the opaque span is in a macro expansion)
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Oct 1, 2026
…ocs, r=Darksonn Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr` The current doc code example for both [`UnixDatagram::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind_addr) and [`UnixListener::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind_addr) attempts binding to an already binded socket address. It's clear that this would always result in a `AddrInUse` error. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular `*::bind` functions (since it will return an error if we pass in a `Path` with interior nul bytes). I thought it would be better to provide an example of how to use this `UnixDatagram::bind_addr` and `UnixListener::bind_addr` via `SocketAddr::from_pathname` since that's general purpose to all platforms within the Unix family. You can verify in this rust playground how the current example (if you switch the `"path/to/socket"` argument to a tmp directory path) always result in an `AddrInUse` error. * [`UnixListener::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=153c9e3131275e9c859dfa47f1d528b6) * [`UnixDatagram::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=a6fdd5cc9c9b08b8c4a58f4c2d6b83cb)
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Oct 1, 2026
…ocs, r=Darksonn Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr` The current doc code example for both [`UnixDatagram::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind_addr) and [`UnixListener::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind_addr) attempts binding to an already binded socket address. It's clear that this would always result in a `AddrInUse` error. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular `*::bind` functions (since it will return an error if we pass in a `Path` with interior nul bytes). I thought it would be better to provide an example of how to use this `UnixDatagram::bind_addr` and `UnixListener::bind_addr` via `SocketAddr::from_pathname` since that's general purpose to all platforms within the Unix family. You can verify in this rust playground how the current example (if you switch the `"path/to/socket"` argument to a tmp directory path) always result in an `AddrInUse` error. * [`UnixListener::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=153c9e3131275e9c859dfa47f1d528b6) * [`UnixDatagram::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=a6fdd5cc9c9b08b8c4a58f4c2d6b83cb)
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Oct 1, 2026
…ocs, r=Darksonn Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr` The current doc code example for both [`UnixDatagram::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind_addr) and [`UnixListener::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind_addr) attempts binding to an already binded socket address. It's clear that this would always result in a `AddrInUse` error. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular `*::bind` functions (since it will return an error if we pass in a `Path` with interior nul bytes). I thought it would be better to provide an example of how to use this `UnixDatagram::bind_addr` and `UnixListener::bind_addr` via `SocketAddr::from_pathname` since that's general purpose to all platforms within the Unix family. You can verify in this rust playground how the current example (if you switch the `"path/to/socket"` argument to a tmp directory path) always result in an `AddrInUse` error. * [`UnixListener::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=153c9e3131275e9c859dfa47f1d528b6) * [`UnixDatagram::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=a6fdd5cc9c9b08b8c4a58f4c2d6b83cb)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 1, 2026
Rollup of 11 pull requests Successful merges: - #163483 (Bump bootstrap compiler to 1.100.0 beta) - #161380 (only rerun const eval in next-solver if the const actually references opaques) - #162900 (Some refactorings around metadata encoding) - #163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - #163584 ([triagebot] Ping me for debugger visualizer changes) - #162904 (Fix ICE for ambiguous candidates on method probing) - #163281 (Add `f16` inline ASM support to `spirv.rs`) - #163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - #163405 (Remove some #[linkage] options) - #163530 (`const impl PartialEq` for `f16b`) - #163581 (do not suggest precise capturing when the opaque span is in a macro expansion)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 1, 2026
…uwer Rollup of 20 pull requests Successful merges: - #163483 (Bump bootstrap compiler to 1.100.0 beta) - #161380 (only rerun const eval in next-solver if the const actually references opaques) - #162900 (Some refactorings around metadata encoding) - #163461 (Improve diagnostic deduplication) - #163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - #163584 ([triagebot] Ping me for debugger visualizer changes) - #159021 (windows-gnu: enable native TLS) - #161467 (wfcheck: name the item that discards an unused type parameter) - #162618 (trait_selection: Preserve eager normalization failures) - #162904 (Fix ICE for ambiguous candidates on method probing) - #163064 (Avoid computing overflowed goal chains for crate dependencies) - #163281 (Add `f16` inline ASM support to `spirv.rs`) - #163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - #163360 ([rustdoc] Correctly handle rustc_allow_incoherent_impl on primitive methods) - #163385 (GVN transmutes of Immediate::Uninit to Immediate::Uninit) - #163405 (Remove some #[linkage] options) - #163530 (`const impl PartialEq` for `f16b`) - #163581 (do not suggest precise capturing when the opaque span is in a macro expansion) - #163590 (Make `AllocatorNightly` less clever) - #163599 (Add union pattern reference change to relnotes)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 1, 2026
…uwer Rollup of 20 pull requests Successful merges: - #163483 (Bump bootstrap compiler to 1.100.0 beta) - #161380 (only rerun const eval in next-solver if the const actually references opaques) - #162900 (Some refactorings around metadata encoding) - #163461 (Improve diagnostic deduplication) - #163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - #163584 ([triagebot] Ping me for debugger visualizer changes) - #159021 (windows-gnu: enable native TLS) - #161467 (wfcheck: name the item that discards an unused type parameter) - #162618 (trait_selection: Preserve eager normalization failures) - #162904 (Fix ICE for ambiguous candidates on method probing) - #163064 (Avoid computing overflowed goal chains for crate dependencies) - #163281 (Add `f16` inline ASM support to `spirv.rs`) - #163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - #163360 ([rustdoc] Correctly handle rustc_allow_incoherent_impl on primitive methods) - #163385 (GVN transmutes of Immediate::Uninit to Immediate::Uninit) - #163405 (Remove some #[linkage] options) - #163530 (`const impl PartialEq` for `f16b`) - #163581 (do not suggest precise capturing when the opaque span is in a macro expansion) - #163590 (Make `AllocatorNightly` less clever) - #163599 (Add union pattern reference change to relnotes)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 2, 2026
…uwer Rollup of 20 pull requests Successful merges: - #163483 (Bump bootstrap compiler to 1.100.0 beta) - #161380 (only rerun const eval in next-solver if the const actually references opaques) - #162900 (Some refactorings around metadata encoding) - #163461 (Improve diagnostic deduplication) - #163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - #163584 ([triagebot] Ping me for debugger visualizer changes) - #159021 (windows-gnu: enable native TLS) - #161467 (wfcheck: name the item that discards an unused type parameter) - #162618 (trait_selection: Preserve eager normalization failures) - #162904 (Fix ICE for ambiguous candidates on method probing) - #163064 (Avoid computing overflowed goal chains for crate dependencies) - #163281 (Add `f16` inline ASM support to `spirv.rs`) - #163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - #163360 ([rustdoc] Correctly handle rustc_allow_incoherent_impl on primitive methods) - #163385 (GVN transmutes of Immediate::Uninit to Immediate::Uninit) - #163405 (Remove some #[linkage] options) - #163530 (`const impl PartialEq` for `f16b`) - #163581 (do not suggest precise capturing when the opaque span is in a macro expansion) - #163590 (Make `AllocatorNightly` less clever) - #163599 (Add union pattern reference change to relnotes)
rust-bors Bot
pushed a commit
that referenced
this pull request
Oct 2, 2026
Rollup merge of #163580 - asder8215:unix_sockets_bind_addr_docs, r=Darksonn Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr` The current doc code example for both [`UnixDatagram::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.bind_addr) and [`UnixListener::bind_addr`](https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html#method.bind_addr) attempts binding to an already binded socket address. It's clear that this would always result in a `AddrInUse` error. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular `*::bind` functions (since it will return an error if we pass in a `Path` with interior nul bytes). I thought it would be better to provide an example of how to use this `UnixDatagram::bind_addr` and `UnixListener::bind_addr` via `SocketAddr::from_pathname` since that's general purpose to all platforms within the Unix family. You can verify in this rust playground how the current example (if you switch the `"path/to/socket"` argument to a tmp directory path) always result in an `AddrInUse` error. * [`UnixListener::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=153c9e3131275e9c859dfa47f1d528b6) * [`UnixDatagram::bind_addr` code example](https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=a6fdd5cc9c9b08b8c4a58f4c2d6b83cb)
flip1995
pushed a commit
to flip1995/rust-clippy
that referenced
this pull request
Oct 3, 2026
…uwer Rollup of 20 pull requests Successful merges: - rust-lang/rust#163483 (Bump bootstrap compiler to 1.100.0 beta) - rust-lang/rust#161380 (only rerun const eval in next-solver if the const actually references opaques) - rust-lang/rust#162900 (Some refactorings around metadata encoding) - rust-lang/rust#163461 (Improve diagnostic deduplication) - rust-lang/rust#163580 (Provide better doc code example for `UnixDatagram::bind_addr` and `UnixListener::bind_addr`) - rust-lang/rust#163584 ([triagebot] Ping me for debugger visualizer changes) - rust-lang/rust#159021 (windows-gnu: enable native TLS) - rust-lang/rust#161467 (wfcheck: name the item that discards an unused type parameter) - rust-lang/rust#162618 (trait_selection: Preserve eager normalization failures) - rust-lang/rust#162904 (Fix ICE for ambiguous candidates on method probing) - rust-lang/rust#163064 (Avoid computing overflowed goal chains for crate dependencies) - rust-lang/rust#163281 (Add `f16` inline ASM support to `spirv.rs`) - rust-lang/rust#163314 (move `#[macro_export]` on declarative macro check to `rustc_attr_parsing`) - rust-lang/rust#163360 ([rustdoc] Correctly handle rustc_allow_incoherent_impl on primitive methods) - rust-lang/rust#163385 (GVN transmutes of Immediate::Uninit to Immediate::Uninit) - rust-lang/rust#163405 (Remove some #[linkage] options) - rust-lang/rust#163530 (`const impl PartialEq` for `f16b`) - rust-lang/rust#163581 (do not suggest precise capturing when the opaque span is in a macro expansion) - rust-lang/rust#163590 (Make `AllocatorNightly` less clever) - rust-lang/rust#163599 (Add union pattern reference change to relnotes)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current doc code example for both
UnixDatagram::bind_addrandUnixListener::bind_addrattempts binding to an already binded socket address. It's clear that this would always result in aAddrInUseerror. I'm pretty certain the original purpose for this function was so that Linux/Android/Cygwin can create an abstract datagram/stream socket through this function as it is impossible to create an abstract socket via the regular*::bindfunctions (since it will return an error if we pass in aPathwith interior nul bytes).I thought it would be better to provide an example of how to use this
UnixDatagram::bind_addrandUnixListener::bind_addrviaSocketAddr::from_pathnamesince that's general purpose to all platforms within the Unix family.You can verify in this rust playground how the current example (if you switch the
"path/to/socket"argument to a tmp directory path) always result in anAddrInUseerror.UnixListener::bind_addrcode exampleUnixDatagram::bind_addrcode example