1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
use crate::{net::Shutdown, os::unix::net::SocketAddr}; use std::{ io, os::unix::{ self, io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}, }, time::Duration, }; /// A Unix datagram socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram`]. /// /// Note that this `UnixDatagram` has no `bind`, `connect`, or `send_to` /// methods. To create a `UnixDatagram`, /// you must first obtain a [`Dir`] containing the path, and then call /// [`Dir::bind_unix_datagram`], [`Dir::connect_unix_datagram`], or /// [`Dir::send_to_unix_datagram_addr`]. /// /// [`std::os::unix::net::UnixDatagram`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html /// [`Dir`]: struct.Dir.html /// [`Dir::connect_unix_datagram`]: struct.Dir.html#method.connect_unix_datagram /// [`Dir::bind_unix_datagram`]: struct.Dir.html#method.bind_unix_datagram /// [`Dir::send_to_unix_datagram_addr`]: struct.Dir.html#method.send_to_unix_datagram_addr pub struct UnixDatagram { std: unix::net::UnixDatagram, } impl UnixDatagram { /// Constructs a new instance of `Self` from the given `std::os::unix::net::UnixDatagram`. /// /// # Safety /// /// `std::os::unix::net::UnixDatagram` is not sandboxed and may access any address that /// the host process has access to. #[inline] pub unsafe fn from_std(std: unix::net::UnixDatagram) -> Self { Self { std } } /// Creates a Unix Datagram socket which is not bound to any address. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::unbound`]. /// /// TODO: should this require a capability? /// /// [`std::os::unix::net::UnixDatagram::unbound`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.unbound #[inline] pub fn unbound() -> io::Result<Self> { let unix_datagram = unix::net::UnixDatagram::unbound()?; Ok(unsafe { Self::from_std(unix_datagram) }) } /// Creates an unnamed pair of connected sockets. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::pair`]. /// /// TODO: should this require a capability? /// /// [`std::os::unix::net::UnixDatagram::pair`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.pair #[inline] pub fn pair() -> io::Result<(Self, Self)> { unix::net::UnixDatagram::pair() .map(|(a, b)| unsafe { (Self::from_std(a), Self::from_std(b)) }) } /// Creates a new independently owned handle to the underlying socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::try_clone`]. /// /// [`std::os::unix::net::UnixDatagram::try_clone`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.try_clone #[inline] pub fn try_clone(&self) -> io::Result<Self> { let unix_datagram = self.std.try_clone()?; Ok(unsafe { Self::from_std(unix_datagram) }) } /// Returns the address of this socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::local_addr`]. /// /// [`std::os::unix::net::UnixDatagram::local_addr`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.local_addr #[inline] pub fn local_addr(&self) -> io::Result<SocketAddr> { self.std.local_addr() } /// Returns the address of this socket's peer. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::peer_addr`]. /// /// [`std::os::unix::net::UnixDatagram::peer_addr`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.peer_addr #[inline] pub fn peer_addr(&self) -> io::Result<SocketAddr> { self.std.peer_addr() } /// Receives data from the socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::recv_from`]. /// /// [`std::os::unix::net::UnixDatagram::recv_from`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.recv_from #[inline] pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { self.std.recv_from(buf) } /// Receives data from the socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::recv`]. /// /// [`std::os::unix::net::UnixDatagram::recv`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.recv #[inline] pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> { self.std.recv(buf) } /// Sends data on the socket to the socket's peer. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::send`]. /// /// [`std::os::unix::net::UnixDatagram::send`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.send #[inline] pub fn send(&self, buf: &[u8]) -> io::Result<usize> { self.std.send(buf) } /// Sets the read timeout for the socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::set_read_timeout`]. /// /// [`std::os::unix::net::UnixDatagram::set_read_timeout`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.set_read_timeout #[inline] pub fn set_read_timeout(&self, timeout: Option<Duration>) -> io::Result<()> { self.std.set_read_timeout(timeout) } /// Sets the write timeout for the socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::set_write_timeout`]. /// /// [`std::os::unix::net::UnixDatagram::set_write_timeout`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.set_write_timeout #[inline] pub fn set_write_timeout(&self, timeout: Option<Duration>) -> io::Result<()> { self.std.set_write_timeout(timeout) } /// Returns the read timeout of this socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::read_timeout`]. /// /// [`std::os::unix::net::UnixDatagram::read_timeout`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.read_timeout #[inline] pub fn read_timeout(&self) -> io::Result<Option<Duration>> { self.std.read_timeout() } /// Returns the write timeout of this socket. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::write_timeout`]. /// /// [`std::os::unix::net::UnixDatagram::write_timeout`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.write_timeout #[inline] pub fn write_timeout(&self) -> io::Result<Option<Duration>> { self.std.write_timeout() } /// Moves the socket into or out of nonblocking mode. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::set_nonblocking`]. /// /// [`std::os::unix::net::UnixDatagram::set_nonblocking`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.set_nonblocking #[inline] pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { self.std.set_nonblocking(nonblocking) } /// Returns the value of the `SO_ERROR` option. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::take_error`]. /// /// [`std::os::unix::net::UnixDatagram::take_error`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.take_error #[inline] pub fn take_error(&self) -> io::Result<Option<io::Error>> { self.std.take_error() } /// Shut down the read, write, or both halves of this connection. /// /// This corresponds to [`std::os::unix::net::UnixDatagram::shutdown`]. /// /// [`std::os::unix::net::UnixDatagram::shutdown`]: https://doc.rust-lang.org/std/os/unix/net/struct.UnixDatagram.html#method.shutdown #[inline] pub fn shutdown(&self, how: Shutdown) -> io::Result<()> { self.std.shutdown(how) } } impl FromRawFd for UnixDatagram { #[inline] unsafe fn from_raw_fd(fd: RawFd) -> Self { Self::from_std(unix::net::UnixDatagram::from_raw_fd(fd)) } } impl AsRawFd for UnixDatagram { #[inline] fn as_raw_fd(&self) -> RawFd { self.std.as_raw_fd() } } impl IntoRawFd for UnixDatagram { #[inline] fn into_raw_fd(self) -> RawFd { self.std.into_raw_fd() } } // TODO: impl Debug for UnixDatagram