diff options
| author | Linus Unnebäck <linus@folkdatorn.se> | 2019-03-12 11:19:33 +0000 |
|---|---|---|
| committer | Linus Unnebäck <linus@folkdatorn.se> | 2019-03-16 11:13:32 +0000 |
| commit | 24e3fa079c150675e1911f1a9f958b690ecaa1bd (patch) | |
| tree | 912392ac86dce11935676c65eb1a912626af403d /src | |
| parent | bf473e3c153dfa84056249864a9f696d72f4e9a9 (diff) | |
| download | rust-24e3fa079c150675e1911f1a9f958b690ecaa1bd.tar.gz rust-24e3fa079c150675e1911f1a9f958b690ecaa1bd.zip | |
Document UdpSocket peer_addr NotConnected error
Diffstat (limited to 'src')
| -rw-r--r-- | src/libstd/net/udp.rs | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/libstd/net/udp.rs b/src/libstd/net/udp.rs index 164039b3032..79e5ae79e4c 100644 --- a/src/libstd/net/udp.rs +++ b/src/libstd/net/udp.rs @@ -193,6 +193,19 @@ impl UdpSocket { /// assert_eq!(socket.peer_addr().unwrap(), /// SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 1), 41203))); /// ``` + /// + /// If the socket isn't connected, it will return a [`NotConnected`] error. + /// + /// [`NotConnected`]: ../../std/io/enum.ErrorKind.html#variant.NotConnected + /// + /// ```no_run + /// #![feature(udp_peer_addr)] + /// use std::net::UdpSocket; + /// + /// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address"); + /// assert_eq!(socket.peer_addr().unwrap_err().kind(), + /// ::std::io::ErrorKind::NotConnected); + /// ``` #[unstable(feature = "udp_peer_addr", issue = "59127")] pub fn peer_addr(&self) -> io::Result<SocketAddr> { self.0.peer_addr() |