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
use crate::net::Shutdown;
use crate::os::unix::net::SocketAddr;
use async_std::io;
use async_std::os::unix;
use async_std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
use io_lifetimes::{AsFd, BorrowedFd, FromFd, IntoFd, OwnedFd};
use std::fmt;
/// A Unix datagram socket.
///
/// This corresponds to [`async_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`].
///
/// [`async_std::os::unix::net::UnixDatagram`]: https://docs.rs/async-std/latest/async_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
/// `async_std::os::unix::net::UnixDatagram`.
///
/// This grants access the resources the
/// `async_std::os::unix::net::UnixDatagram` instance already has access
/// to.
#[inline]
pub 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
/// [`async_std::os::unix::net::UnixDatagram::unbound`].
///
/// TODO: should this require a capability?
///
/// [`async_std::os::unix::net::UnixDatagram::unbound`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.unbound
#[inline]
pub fn unbound() -> io::Result<Self> {
let unix_datagram = unix::net::UnixDatagram::unbound()?;
Ok(Self::from_std(unix_datagram))
}
/// Creates an unnamed pair of connected sockets.
///
/// This corresponds to [`async_std::os::unix::net::UnixDatagram::pair`].
///
/// TODO: should this require a capability?
///
/// [`async_std::os::unix::net::UnixDatagram::pair`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.pair
#[inline]
pub fn pair() -> io::Result<(Self, Self)> {
unix::net::UnixDatagram::pair().map(|(a, b)| (Self::from_std(a), Self::from_std(b)))
}
// async_std doesn't have `try_clone`.
/// Returns the address of this socket.
///
/// This corresponds to
/// [`async_std::os::unix::net::UnixDatagram::local_addr`].
///
/// [`async_std::os::unix::net::UnixDatagram::local_addr`]: https://docs.rs/async-std/latest/async_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
/// [`async_std::os::unix::net::UnixDatagram::peer_addr`].
///
/// [`async_std::os::unix::net::UnixDatagram::peer_addr`]: https://docs.rs/async-std/latest/async_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
/// [`async_std::os::unix::net::UnixDatagram::recv_from`].
///
/// [`async_std::os::unix::net::UnixDatagram::recv_from`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.recv_from
#[inline]
pub async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
self.std.recv_from(buf).await
}
/// Receives data from the socket.
///
/// This corresponds to [`async_std::os::unix::net::UnixDatagram::recv`].
///
/// [`async_std::os::unix::net::UnixDatagram::recv`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.recv
#[inline]
pub async fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
self.std.recv(buf).await
}
/// Sends data on the socket to the socket's peer.
///
/// This corresponds to [`async_std::os::unix::net::UnixDatagram::send`].
///
/// [`async_std::os::unix::net::UnixDatagram::send`]: https://docs.rs/async-std/latest/async_std/os/unix/net/struct.UnixDatagram.html#method.send
#[inline]
pub async fn send(&self, buf: &[u8]) -> io::Result<usize> {
self.std.send(buf).await
}
// async_std doesn't have `set_read_timeout`.
// async_std doesn't have `set_write_timeout`.
// async_std doesn't have `read_timeout`.
// async_std doesn't have `write_timeout`.
// async_std doesn't have `set_nonblocking`.
// async_std doesn't have `take_error`.
/// Shut down the read, write, or both halves of this connection.
///
/// This corresponds to
/// [`async_std::os::unix::net::UnixDatagram::shutdown`].
///
/// [`async_std::os::unix::net::UnixDatagram::shutdown`]: https://docs.rs/async-std/latest/async_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 FromFd for UnixDatagram {
#[inline]
fn from_fd(fd: OwnedFd) -> Self {
Self::from_std(unix::net::UnixDatagram::from_fd(fd))
}
}
impl AsRawFd for UnixDatagram {
#[inline]
fn as_raw_fd(&self) -> RawFd {
self.std.as_raw_fd()
}
}
impl AsFd for UnixDatagram {
#[inline]
fn as_fd(&self) -> BorrowedFd<'_> {
self.std.as_fd()
}
}
impl IntoRawFd for UnixDatagram {
#[inline]
fn into_raw_fd(self) -> RawFd {
self.std.into_raw_fd()
}
}
impl IntoFd for UnixDatagram {
#[inline]
fn into_fd(self) -> OwnedFd {
self.std.into_fd()
}
}
impl fmt::Debug for UnixDatagram {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.std.fmt(f)
}
}