pub struct UnixDatagram(/* private fields */);
Expand description
A Unix datagram socket.
§Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::bind("/path/to/my/socket")?;
socket.send_to(b"hello world", "/path/to/other/socket")?;
let mut buf = [0; 100];
let (count, address) = socket.recv_from(&mut buf)?;
println!("socket {:?} sent {:?}", address, &buf[..count]);
Ok(())
}
Implementations§
source§impl UnixDatagram
impl UnixDatagram
1.10.0 · sourcepub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>
pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>
Creates a Unix datagram socket bound to the given path.
§Examples
1.70.0 · sourcepub fn bind_addr(socket_addr: &SocketAddr) -> Result<UnixDatagram>
pub fn bind_addr(socket_addr: &SocketAddr) -> Result<UnixDatagram>
Creates a Unix datagram socket bound to an address.
§Examples
use std::os::unix::net::{UnixDatagram};
fn main() -> std::io::Result<()> {
let sock1 = UnixDatagram::bind("path/to/socket")?;
let addr = sock1.local_addr()?;
let sock2 = match UnixDatagram::bind_addr(&addr) {
Ok(sock) => sock,
Err(err) => {
println!("Couldn't bind: {err:?}");
return Err(err);
}
};
Ok(())
}
1.10.0 · sourcepub fn unbound() -> Result<UnixDatagram>
pub fn unbound() -> Result<UnixDatagram>
Creates a Unix Datagram socket which is not bound to any address.
§Examples
1.10.0 · sourcepub fn pair() -> Result<(UnixDatagram, UnixDatagram)>
pub fn pair() -> Result<(UnixDatagram, UnixDatagram)>
Creates an unnamed pair of connected sockets.
Returns two UnixDatagrams
s which are connected to each other.
§Examples
1.10.0 · sourcepub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>
pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>
1.70.0 · sourcepub fn connect_addr(&self, socket_addr: &SocketAddr) -> Result<()>
pub fn connect_addr(&self, socket_addr: &SocketAddr) -> Result<()>
Connects the socket to an address.
§Examples
use std::os::unix::net::{UnixDatagram};
fn main() -> std::io::Result<()> {
let bound = UnixDatagram::bind("/path/to/socket")?;
let addr = bound.local_addr()?;
let sock = UnixDatagram::unbound()?;
match sock.connect_addr(&addr) {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't connect: {e:?}");
return Err(e)
}
};
Ok(())
}
1.10.0 · sourcepub fn try_clone(&self) -> Result<UnixDatagram>
pub fn try_clone(&self) -> Result<UnixDatagram>
Creates a new independently owned handle to the underlying socket.
The returned UnixDatagram
is a reference to the same socket that this
object references. Both handles can be used to accept incoming
connections and options set on one side will affect the other.
§Examples
1.10.0 · sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the address of this socket.
§Examples
1.10.0 · sourcepub fn peer_addr(&self) -> Result<SocketAddr>
pub fn peer_addr(&self) -> Result<SocketAddr>
1.10.0 · sourcepub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
Receives data from the socket.
On success, returns the number of bytes read and the address from whence the data came.
§Examples
1.10.0 · sourcepub fn recv(&self, buf: &mut [u8]) -> Result<usize>
pub fn recv(&self, buf: &mut [u8]) -> Result<usize>
sourcepub fn recv_vectored_with_ancillary_from(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>,
) -> Result<(usize, bool, SocketAddr)>
🔬This is a nightly-only experimental API. (unix_socket_ancillary_data
#76915)
pub fn recv_vectored_with_ancillary_from( &self, bufs: &mut [IoSliceMut<'_>], ancillary: &mut SocketAncillary<'_>, ) -> Result<(usize, bool, SocketAddr)>
unix_socket_ancillary_data
#76915)Receives data and ancillary data from socket.
On success, returns the number of bytes read, if the data was truncated and the address from whence the msg came.
§Examples
#![feature(unix_socket_ancillary_data)]
use std::os::unix::net::{UnixDatagram, SocketAncillary, AncillaryData};
use std::io::IoSliceMut;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
let mut buf1 = [1; 8];
let mut buf2 = [2; 16];
let mut buf3 = [3; 8];
let mut bufs = &mut [
IoSliceMut::new(&mut buf1),
IoSliceMut::new(&mut buf2),
IoSliceMut::new(&mut buf3),
][..];
let mut fds = [0; 8];
let mut ancillary_buffer = [0; 128];
let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
let (size, _truncated, sender) = sock.recv_vectored_with_ancillary_from(bufs, &mut ancillary)?;
println!("received {size}");
for ancillary_result in ancillary.messages() {
if let AncillaryData::ScmRights(scm_rights) = ancillary_result.unwrap() {
for fd in scm_rights {
println!("receive file descriptor: {fd}");
}
}
}
Ok(())
}
sourcepub fn recv_vectored_with_ancillary(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>,
) -> Result<(usize, bool)>
🔬This is a nightly-only experimental API. (unix_socket_ancillary_data
#76915)
pub fn recv_vectored_with_ancillary( &self, bufs: &mut [IoSliceMut<'_>], ancillary: &mut SocketAncillary<'_>, ) -> Result<(usize, bool)>
unix_socket_ancillary_data
#76915)Receives data and ancillary data from socket.
On success, returns the number of bytes read and if the data was truncated.
§Examples
#![feature(unix_socket_ancillary_data)]
use std::os::unix::net::{UnixDatagram, SocketAncillary, AncillaryData};
use std::io::IoSliceMut;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
let mut buf1 = [1; 8];
let mut buf2 = [2; 16];
let mut buf3 = [3; 8];
let mut bufs = &mut [
IoSliceMut::new(&mut buf1),
IoSliceMut::new(&mut buf2),
IoSliceMut::new(&mut buf3),
][..];
let mut fds = [0; 8];
let mut ancillary_buffer = [0; 128];
let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
let (size, _truncated) = sock.recv_vectored_with_ancillary(bufs, &mut ancillary)?;
println!("received {size}");
for ancillary_result in ancillary.messages() {
if let AncillaryData::ScmRights(scm_rights) = ancillary_result.unwrap() {
for fd in scm_rights {
println!("receive file descriptor: {fd}");
}
}
}
Ok(())
}
1.10.0 · sourcepub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>
pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>
Sends data on the socket to the specified address.
On success, returns the number of bytes written.
§Examples
1.70.0 · sourcepub fn send_to_addr(
&self,
buf: &[u8],
socket_addr: &SocketAddr,
) -> Result<usize>
pub fn send_to_addr( &self, buf: &[u8], socket_addr: &SocketAddr, ) -> Result<usize>
Sends data on the socket to the specified SocketAddr.
On success, returns the number of bytes written.
§Examples
1.10.0 · sourcepub fn send(&self, buf: &[u8]) -> Result<usize>
pub fn send(&self, buf: &[u8]) -> Result<usize>
Sends data on the socket to the socket’s peer.
The peer address may be set by the connect
method, and this method
will return an error if the socket has not already been connected.
On success, returns the number of bytes written.
§Examples
sourcepub fn send_vectored_with_ancillary_to<P: AsRef<Path>>(
&self,
bufs: &[IoSlice<'_>],
ancillary: &mut SocketAncillary<'_>,
path: P,
) -> Result<usize>
🔬This is a nightly-only experimental API. (unix_socket_ancillary_data
#76915)
pub fn send_vectored_with_ancillary_to<P: AsRef<Path>>( &self, bufs: &[IoSlice<'_>], ancillary: &mut SocketAncillary<'_>, path: P, ) -> Result<usize>
unix_socket_ancillary_data
#76915)Sends data and ancillary data on the socket to the specified address.
On success, returns the number of bytes written.
§Examples
#![feature(unix_socket_ancillary_data)]
use std::os::unix::net::{UnixDatagram, SocketAncillary};
use std::io::IoSlice;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
let buf1 = [1; 8];
let buf2 = [2; 16];
let buf3 = [3; 8];
let bufs = &[
IoSlice::new(&buf1),
IoSlice::new(&buf2),
IoSlice::new(&buf3),
][..];
let fds = [0, 1, 2];
let mut ancillary_buffer = [0; 128];
let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
ancillary.add_fds(&fds[..]);
sock.send_vectored_with_ancillary_to(bufs, &mut ancillary, "/some/sock")
.expect("send_vectored_with_ancillary_to function failed");
Ok(())
}
sourcepub fn send_vectored_with_ancillary(
&self,
bufs: &[IoSlice<'_>],
ancillary: &mut SocketAncillary<'_>,
) -> Result<usize>
🔬This is a nightly-only experimental API. (unix_socket_ancillary_data
#76915)
pub fn send_vectored_with_ancillary( &self, bufs: &[IoSlice<'_>], ancillary: &mut SocketAncillary<'_>, ) -> Result<usize>
unix_socket_ancillary_data
#76915)Sends data and ancillary data on the socket.
On success, returns the number of bytes written.
§Examples
#![feature(unix_socket_ancillary_data)]
use std::os::unix::net::{UnixDatagram, SocketAncillary};
use std::io::IoSlice;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
let buf1 = [1; 8];
let buf2 = [2; 16];
let buf3 = [3; 8];
let bufs = &[
IoSlice::new(&buf1),
IoSlice::new(&buf2),
IoSlice::new(&buf3),
][..];
let fds = [0, 1, 2];
let mut ancillary_buffer = [0; 128];
let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
ancillary.add_fds(&fds[..]);
sock.send_vectored_with_ancillary(bufs, &mut ancillary)
.expect("send_vectored_with_ancillary function failed");
Ok(())
}
1.10.0 · sourcepub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>
pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>
Sets the read timeout for the socket.
If the provided value is None
, then recv
and recv_from
calls will
block indefinitely. An Err
is returned if the zero Duration
is passed to this method.
§Examples
use std::os::unix::net::UnixDatagram;
use std::time::Duration;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.set_read_timeout(Some(Duration::new(1, 0)))
.expect("set_read_timeout function failed");
Ok(())
}
An Err
is returned if the zero Duration
is passed to this
method:
use std::io;
use std::os::unix::net::UnixDatagram;
use std::time::Duration;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::unbound()?;
let result = socket.set_read_timeout(Some(Duration::new(0, 0)));
let err = result.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
Ok(())
}
1.10.0 · sourcepub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>
pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>
Sets the write timeout for the socket.
If the provided value is None
, then send
and send_to
calls will
block indefinitely. An Err
is returned if the zero Duration
is passed to this
method.
§Examples
use std::os::unix::net::UnixDatagram;
use std::time::Duration;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.set_write_timeout(Some(Duration::new(1, 0)))
.expect("set_write_timeout function failed");
Ok(())
}
An Err
is returned if the zero Duration
is passed to this
method:
use std::io;
use std::os::unix::net::UnixDatagram;
use std::time::Duration;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::unbound()?;
let result = socket.set_write_timeout(Some(Duration::new(0, 0)));
let err = result.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
Ok(())
}
1.10.0 · sourcepub fn read_timeout(&self) -> Result<Option<Duration>>
pub fn read_timeout(&self) -> Result<Option<Duration>>
Returns the read timeout of this socket.
§Examples
1.10.0 · sourcepub fn write_timeout(&self) -> Result<Option<Duration>>
pub fn write_timeout(&self) -> Result<Option<Duration>>
Returns the write timeout of this socket.
§Examples
use std::os::unix::net::UnixDatagram;
use std::time::Duration;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.set_write_timeout(Some(Duration::new(1, 0)))
.expect("set_write_timeout function failed");
assert_eq!(sock.write_timeout()?, Some(Duration::new(1, 0)));
Ok(())
}
1.10.0 · sourcepub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
Moves the socket into or out of nonblocking mode.
§Examples
sourcepub fn set_mark(&self, mark: u32) -> Result<()>
🔬This is a nightly-only experimental API. (unix_set_mark
#96467)
pub fn set_mark(&self, mark: u32) -> Result<()>
unix_set_mark
#96467)1.10.0 · sourcepub fn take_error(&self) -> Result<Option<Error>>
pub fn take_error(&self) -> Result<Option<Error>>
Returns the value of the SO_ERROR
option.
§Examples
1.10.0 · sourcepub fn shutdown(&self, how: Shutdown) -> Result<()>
pub fn shutdown(&self, how: Shutdown) -> Result<()>
Shut down the read, write, or both halves of this connection.
This function will cause all pending and future I/O calls on the
specified portions to immediately return with an appropriate value
(see the documentation of Shutdown
).
sourcepub fn peek(&self, buf: &mut [u8]) -> Result<usize>
🔬This is a nightly-only experimental API. (unix_socket_peek
#76923)
pub fn peek(&self, buf: &mut [u8]) -> Result<usize>
unix_socket_peek
#76923)Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.
Successive calls return the same data. This is accomplished by passing
MSG_PEEK
as a flag to the underlying recv
system call.
§Examples
sourcepub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
🔬This is a nightly-only experimental API. (unix_socket_peek
#76923)
pub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
unix_socket_peek
#76923)Receives a single datagram message on the socket, without removing it from the queue. On success, returns the number of bytes read and the origin.
The function must be called with valid byte array buf
of sufficient size to
hold the message bytes. If a message is too long to fit in the supplied buffer,
excess bytes may be discarded.
Successive calls return the same data. This is accomplished by passing
MSG_PEEK
as a flag to the underlying recvfrom
system call.
Do not use this function to implement busy waiting, instead use libc::poll
to
synchronize IO events on one or more sockets.
§Examples
Trait Implementations§
1.63.0 · source§impl AsFd for UnixDatagram
impl AsFd for UnixDatagram
source§fn as_fd(&self) -> BorrowedFd<'_>
fn as_fd(&self) -> BorrowedFd<'_>
1.10.0 · source§impl AsRawFd for UnixDatagram
impl AsRawFd for UnixDatagram
1.10.0 · source§impl Debug for UnixDatagram
impl Debug for UnixDatagram
1.63.0 · source§impl From<OwnedFd> for UnixDatagram
impl From<OwnedFd> for UnixDatagram
1.63.0 · source§impl From<UnixDatagram> for OwnedFd
impl From<UnixDatagram> for OwnedFd
source§fn from(unix_datagram: UnixDatagram) -> OwnedFd
fn from(unix_datagram: UnixDatagram) -> OwnedFd
Takes ownership of a UnixDatagram
’s socket file descriptor.
1.10.0 · source§impl FromRawFd for UnixDatagram
impl FromRawFd for UnixDatagram
source§unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram
unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram
Self
from the given raw file
descriptor. Read more