Struct otter_api_tests::crates::otter_support::imports::unix::net::UnixDatagram
1.10.0 · source · [−]pub struct UnixDatagram(_);
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
sourceimpl UnixDatagram
impl UnixDatagram
sourcepub fn bind<P>(path: P) -> Result<UnixDatagram, Error> where
P: AsRef<Path>,
pub fn bind<P>(path: P) -> Result<UnixDatagram, Error> where
P: AsRef<Path>,
Creates a Unix datagram socket bound to the given path.
Examples
use std::os::unix::net::UnixDatagram;
let sock = match UnixDatagram::bind("/path/to/the/socket") {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't bind: {e:?}");
return
}
};
sourcepub fn bind_addr(socket_addr: &SocketAddr) -> Result<UnixDatagram, Error>
🔬 This is a nightly-only experimental API. (unix_socket_abstract
)
pub fn bind_addr(socket_addr: &SocketAddr) -> Result<UnixDatagram, Error>
unix_socket_abstract
)Creates a Unix datagram socket bound to an address.
Examples
#![feature(unix_socket_abstract)]
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(())
}
sourcepub fn unbound() -> Result<UnixDatagram, Error>
pub fn unbound() -> Result<UnixDatagram, Error>
Creates a Unix Datagram socket which is not bound to any address.
Examples
use std::os::unix::net::UnixDatagram;
let sock = match UnixDatagram::unbound() {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't unbound: {e:?}");
return
}
};
sourcepub fn pair() -> Result<(UnixDatagram, UnixDatagram), Error>
pub fn pair() -> Result<(UnixDatagram, UnixDatagram), Error>
Creates an unnamed pair of connected sockets.
Returns two UnixDatagrams
s which are connected to each other.
Examples
use std::os::unix::net::UnixDatagram;
let (sock1, sock2) = match UnixDatagram::pair() {
Ok((sock1, sock2)) => (sock1, sock2),
Err(e) => {
println!("Couldn't unbound: {e:?}");
return
}
};
sourcepub fn connect<P>(&self, path: P) -> Result<(), Error> where
P: AsRef<Path>,
pub fn connect<P>(&self, path: P) -> Result<(), Error> where
P: AsRef<Path>,
Connects the socket to the specified path address.
The send
method may be used to send data to the specified address.
recv
and recv_from
will only receive data from that address.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
match sock.connect("/path/to/the/socket") {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't connect: {e:?}");
return Err(e)
}
};
Ok(())
}
sourcepub fn connect_addr(&self, socket_addr: &SocketAddr) -> Result<(), Error>
🔬 This is a nightly-only experimental API. (unix_socket_abstract
)
pub fn connect_addr(&self, socket_addr: &SocketAddr) -> Result<(), Error>
unix_socket_abstract
)Connects the socket to an address.
Examples
#![feature(unix_socket_abstract)]
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(())
}
sourcepub fn try_clone(&self) -> Result<UnixDatagram, Error>
pub fn try_clone(&self) -> Result<UnixDatagram, Error>
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
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::bind("/path/to/the/socket")?;
let sock_copy = sock.try_clone().expect("try_clone failed");
Ok(())
}
sourcepub fn local_addr(&self) -> Result<SocketAddr, Error>
pub fn local_addr(&self) -> Result<SocketAddr, Error>
Returns the address of this socket.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::bind("/path/to/the/socket")?;
let addr = sock.local_addr().expect("Couldn't get local address");
Ok(())
}
sourcepub fn peer_addr(&self) -> Result<SocketAddr, Error>
pub fn peer_addr(&self) -> Result<SocketAddr, Error>
Returns the address of this socket’s peer.
The connect
method will connect the socket to a peer.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.connect("/path/to/the/socket")?;
let addr = sock.peer_addr().expect("Couldn't get peer address");
Ok(())
}
sourcepub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr), Error>
pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr), Error>
Receives data from the socket.
On success, returns the number of bytes read and the address from whence the data came.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
let mut buf = vec![0; 10];
let (size, sender) = sock.recv_from(buf.as_mut_slice())?;
println!("received {size} bytes from {sender:?}");
Ok(())
}
sourcepub fn recv(&self, buf: &mut [u8]) -> Result<usize, Error>
pub fn recv(&self, buf: &mut [u8]) -> Result<usize, Error>
Receives data from the socket.
On success, returns the number of bytes read.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::bind("/path/to/the/socket")?;
let mut buf = vec![0; 10];
sock.recv(buf.as_mut_slice()).expect("recv function failed");
Ok(())
}
sourcepub fn recv_vectored_with_ancillary_from(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<(usize, bool, SocketAddr), Error>
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn recv_vectored_with_ancillary_from(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<(usize, bool, SocketAddr), Error>
unix_socket_ancillary_data
)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), Error>
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn recv_vectored_with_ancillary(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<(usize, bool), Error>
unix_socket_ancillary_data
)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(())
}
sourcepub fn send_to<P>(&self, buf: &[u8], path: P) -> Result<usize, Error> where
P: AsRef<Path>,
pub fn send_to<P>(&self, buf: &[u8], path: P) -> Result<usize, Error> where
P: AsRef<Path>,
Sends data on the socket to the specified address.
On success, returns the number of bytes written.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.send_to(b"omelette au fromage", "/some/sock").expect("send_to function failed");
Ok(())
}
sourcepub fn send_to_addr(
&self,
buf: &[u8],
socket_addr: &SocketAddr
) -> Result<usize, Error>
🔬 This is a nightly-only experimental API. (unix_socket_abstract
)
pub fn send_to_addr(
&self,
buf: &[u8],
socket_addr: &SocketAddr
) -> Result<usize, Error>
unix_socket_abstract
)Sends data on the socket to the specified SocketAddr.
On success, returns the number of bytes written.
Examples
#![feature(unix_socket_abstract)]
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()?;
sock.send_to_addr(b"bacon egg and cheese", &addr).expect("send_to_addr function failed");
Ok(())
}
sourcepub fn send(&self, buf: &[u8]) -> Result<usize, Error>
pub fn send(&self, buf: &[u8]) -> Result<usize, Error>
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
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.connect("/some/sock").expect("Couldn't connect");
sock.send(b"omelette au fromage").expect("send_to function failed");
Ok(())
}
sourcepub fn send_vectored_with_ancillary_to<P>(
&self,
bufs: &[IoSlice<'_>],
ancillary: &mut SocketAncillary<'_>,
path: P
) -> Result<usize, Error> where
P: AsRef<Path>,
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn send_vectored_with_ancillary_to<P>(
&self,
bufs: &[IoSlice<'_>],
ancillary: &mut SocketAncillary<'_>,
path: P
) -> Result<usize, Error> where
P: AsRef<Path>,
unix_socket_ancillary_data
)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, Error>
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn send_vectored_with_ancillary(
&self,
bufs: &[IoSlice<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<usize, Error>
unix_socket_ancillary_data
)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(())
}
sourcepub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
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(())
}
sourcepub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
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(())
}
sourcepub fn read_timeout(&self) -> Result<Option<Duration>, Error>
pub fn read_timeout(&self) -> Result<Option<Duration>, Error>
Returns the read 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_read_timeout(Some(Duration::new(1, 0)))
.expect("set_read_timeout function failed");
assert_eq!(sock.read_timeout()?, Some(Duration::new(1, 0)));
Ok(())
}
sourcepub fn write_timeout(&self) -> Result<Option<Duration>, Error>
pub fn write_timeout(&self) -> Result<Option<Duration>, Error>
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(())
}
sourcepub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), Error>
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), Error>
Moves the socket into or out of nonblocking mode.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.set_nonblocking(true).expect("set_nonblocking function failed");
Ok(())
}
sourcepub fn set_passcred(&self, passcred: bool) -> Result<(), Error>
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn set_passcred(&self, passcred: bool) -> Result<(), Error>
unix_socket_ancillary_data
)Moves the socket to pass unix credentials as control message in SocketAncillary
.
Set the socket option SO_PASSCRED
.
Examples
#![feature(unix_socket_ancillary_data)]
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.set_passcred(true).expect("set_passcred function failed");
Ok(())
}
sourcepub fn passcred(&self) -> Result<bool, Error>
🔬 This is a nightly-only experimental API. (unix_socket_ancillary_data
)
pub fn passcred(&self) -> Result<bool, Error>
unix_socket_ancillary_data
)Get the current value of the socket for passing unix credentials in SocketAncillary
.
This value can be change by set_passcred
.
Get the socket option SO_PASSCRED
.
sourcepub fn take_error(&self) -> Result<Option<Error>, Error>
pub fn take_error(&self) -> Result<Option<Error>, Error>
Returns the value of the SO_ERROR
option.
Examples
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
if let Ok(Some(err)) = sock.take_error() {
println!("Got error: {err:?}");
}
Ok(())
}
sourcepub fn shutdown(&self, how: Shutdown) -> Result<(), Error>
pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>
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
).
use std::os::unix::net::UnixDatagram;
use std::net::Shutdown;
fn main() -> std::io::Result<()> {
let sock = UnixDatagram::unbound()?;
sock.shutdown(Shutdown::Both).expect("shutdown function failed");
Ok(())
}
sourcepub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>
🔬 This is a nightly-only experimental API. (unix_socket_peek
)
pub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>
unix_socket_peek
)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
#![feature(unix_socket_peek)]
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::bind("/tmp/sock")?;
let mut buf = [0; 10];
let len = socket.peek(&mut buf).expect("peek failed");
Ok(())
}
sourcepub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr), Error>
🔬 This is a nightly-only experimental API. (unix_socket_peek
)
pub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr), Error>
unix_socket_peek
)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
#![feature(unix_socket_peek)]
use std::os::unix::net::UnixDatagram;
fn main() -> std::io::Result<()> {
let socket = UnixDatagram::bind("/tmp/sock")?;
let mut buf = [0; 10];
let (len, addr) = socket.peek_from(&mut buf).expect("peek failed");
Ok(())
}
Trait Implementations
1.63.0 · sourceimpl AsFd for UnixDatagram
impl AsFd for UnixDatagram
sourcefn as_fd(&self) -> BorrowedFd<'_>
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
sourceimpl AsRawFd for UnixDatagram
impl AsRawFd for UnixDatagram
sourceimpl Debug for UnixDatagram
impl Debug for UnixDatagram
1.63.0 · sourceimpl From<OwnedFd> for UnixDatagram
impl From<OwnedFd> for UnixDatagram
sourcefn from(owned: OwnedFd) -> UnixDatagram
fn from(owned: OwnedFd) -> UnixDatagram
Converts to this type from the input type.
sourceimpl From<Socket> for UnixDatagram
impl From<Socket> for UnixDatagram
sourcefn from(socket: Socket) -> UnixDatagram
fn from(socket: Socket) -> UnixDatagram
Converts to this type from the input type.
1.63.0 · sourceimpl From<UnixDatagram> for OwnedFd
impl From<UnixDatagram> for OwnedFd
sourcefn from(unix_datagram: UnixDatagram) -> OwnedFd
fn from(unix_datagram: UnixDatagram) -> OwnedFd
Converts to this type from the input type.
sourceimpl From<UnixDatagram> for Socket
impl From<UnixDatagram> for Socket
sourceimpl FromRawFd for UnixDatagram
impl FromRawFd for UnixDatagram
sourceunsafe fn from_raw_fd(fd: i32) -> UnixDatagram
unsafe fn from_raw_fd(fd: i32) -> UnixDatagram
Constructs a new instance of Self
from the given raw file
descriptor. Read more
sourceimpl IntoRawFd for UnixDatagram
impl IntoRawFd for UnixDatagram
sourcefn into_raw_fd(self) -> i32
fn into_raw_fd(self) -> i32
Consumes this object, returning the raw underlying file descriptor. Read more
impl TryFrom<UnixDatagram> for UnixDatagram
impl TryFrom<UnixDatagram> for UnixDatagram
fn try_from(
stream: UnixDatagram
) -> Result<UnixDatagram, <UnixDatagram as TryFrom<UnixDatagram>>::Error>
fn try_from(
stream: UnixDatagram
) -> Result<UnixDatagram, <UnixDatagram as TryFrom<UnixDatagram>>::Error>
Consumes stream, returning the Tokio I/O object.
This is equivalent to
UnixDatagram::from_std(stream)
.
impl UnixDatagramExt for UnixDatagram
impl UnixDatagramExt for UnixDatagram
fn bind_unix_addr(addr: &UnixSocketAddr) -> Result<UnixDatagram, Error>
fn bind_unix_addr(addr: &UnixSocketAddr) -> Result<UnixDatagram, Error>
Create a socket bound to a path or abstract name. Read more
fn local_unix_addr(&self) -> Result<UnixSocketAddr, Error>
fn local_unix_addr(&self) -> Result<UnixSocketAddr, Error>
Returns the address of this socket, as a type that fully supports abstract addresses.
fn peer_unix_addr(&self) -> Result<UnixSocketAddr, Error>
fn peer_unix_addr(&self) -> Result<UnixSocketAddr, Error>
Returns the address of the connected socket, as a type that fully supports abstract addresses.
fn bind_to_unix_addr(&self, addr: &UnixSocketAddr) -> Result<(), Error>
fn bind_to_unix_addr(&self, addr: &UnixSocketAddr) -> Result<(), Error>
Creates a path or abstract name for the socket.
fn connect_to_unix_addr(&self, addr: &UnixSocketAddr) -> Result<(), Error>
fn connect_to_unix_addr(&self, addr: &UnixSocketAddr) -> Result<(), Error>
Connects the socket to a path-based or abstract named socket.
fn send_to_unix_addr(
&self,
datagram: &[u8],
addr: &UnixSocketAddr
) -> Result<usize, Error>
fn send_to_unix_addr(
&self,
datagram: &[u8],
addr: &UnixSocketAddr
) -> Result<usize, Error>
Sends to the specified address, using an address type that supports abstract addresses. Read more
fn send_vectored_to_unix_addr(
&self,
datagram: &[IoSlice<'_>],
addr: &UnixSocketAddr
) -> Result<usize, Error>
fn send_vectored_to_unix_addr(
&self,
datagram: &[IoSlice<'_>],
addr: &UnixSocketAddr
) -> Result<usize, Error>
Sends a datagram created from multiple segments to the specified address, using an address type that supports abstract addresses. Read more
fn recv_from_unix_addr(
&self,
buf: &mut [u8]
) -> Result<(usize, UnixSocketAddr), Error>
fn recv_from_unix_addr(
&self,
buf: &mut [u8]
) -> Result<(usize, UnixSocketAddr), Error>
Receives from any peer, storing its address in a type that exposes abstract addresses. Read more
fn recv_vectored_from_unix_addr(
&self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<(usize, UnixSocketAddr), Error>
fn recv_vectored_from_unix_addr(
&self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<(usize, UnixSocketAddr), Error>
Uses multiple buffers to receive from any peer, storing its address in a type that exposes abstract addresses. Read more
fn peek_from_unix_addr(
&self,
buf: &mut [u8]
) -> Result<(usize, UnixSocketAddr), Error>
fn peek_from_unix_addr(
&self,
buf: &mut [u8]
) -> Result<(usize, UnixSocketAddr), Error>
Reads the next datagram without removing it from the queue. Read more
fn peek_vectored_from_unix_addr(
&self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<(usize, UnixSocketAddr), Error>
fn peek_vectored_from_unix_addr(
&self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<(usize, UnixSocketAddr), Error>
Uses multiple buffers to read the next datagram without removing it from the queue. Read more
fn send_fds_to(
&self,
datagram: &[u8],
fds: &[i32],
addr: &UnixSocketAddr
) -> Result<usize, Error>
fn send_fds_to(
&self,
datagram: &[u8],
fds: &[i32],
addr: &UnixSocketAddr
) -> Result<usize, Error>
Sends file descriptors along with the datagram, on an unconnected socket.
fn send_fds(&self, datagram: &[u8], fds: &[i32]) -> Result<usize, Error>
fn send_fds(&self, datagram: &[u8], fds: &[i32]) -> Result<usize, Error>
Sends file descriptors along with the datagram, on a connected socket.
fn recv_fds_from(
&self,
buf: &mut [u8],
fd_buf: &mut [i32]
) -> Result<(usize, usize, UnixSocketAddr), Error>
fn recv_fds_from(
&self,
buf: &mut [u8],
fd_buf: &mut [i32]
) -> Result<(usize, usize, UnixSocketAddr), Error>
Receives file descriptors along with the datagram, on an unconnected socket
fn recv_fds(
&self,
buf: &mut [u8],
fd_buf: &mut [i32]
) -> Result<(usize, usize), Error>
fn recv_fds(
&self,
buf: &mut [u8],
fd_buf: &mut [i32]
) -> Result<(usize, usize), Error>
Receives file descriptors along with the datagram, on a connected socket
fn initial_pair_credentials(&self) -> Result<ConnCredentials, Error>
fn initial_pair_credentials(&self) -> Result<ConnCredentials, Error>
Returns the credentials of the process that created a socket pair. Read more
Auto Trait Implementations
impl RefUnwindSafe for UnixDatagram
impl Send for UnixDatagram
impl Sync for UnixDatagram
impl Unpin for UnixDatagram
impl UnwindSafe for UnixDatagram
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<A> DynCastExt for A
impl<A> DynCastExt for A
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
Use this to cast from one trait object type to another. Read more
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
Use this to upcast a trait to one of its supertraits. Read more
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more