pub struct UnixDatagram { /* private fields */ }
Expand description
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
].
[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
Implementations
sourceimpl UnixDatagram
impl UnixDatagram
sourcepub fn from_std(std: UnixDatagram) -> Self
pub fn from_std(std: UnixDatagram) -> Self
Constructs a new instance of Self
from the given
std::os::unix::net::UnixDatagram
.
This grants access the resources the std::os::unix::net::UnixDatagram
instance already has access to.
sourcepub fn unbound() -> Result<Self>
pub fn unbound() -> Result<Self>
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?
sourcepub fn pair() -> Result<(Self, Self)>
pub fn pair() -> Result<(Self, Self)>
Creates an unnamed pair of connected sockets.
This corresponds to std::os::unix::net::UnixDatagram::pair
.
TODO: should this require a capability?
sourcepub fn try_clone(&self) -> Result<Self>
pub fn try_clone(&self) -> Result<Self>
Creates a new independently owned handle to the underlying socket.
This corresponds to std::os::unix::net::UnixDatagram::try_clone
.
sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the address of this socket.
This corresponds to std::os::unix::net::UnixDatagram::local_addr
.
sourcepub fn peer_addr(&self) -> Result<SocketAddr>
pub fn peer_addr(&self) -> Result<SocketAddr>
Returns the address of this socket’s peer.
This corresponds to std::os::unix::net::UnixDatagram::peer_addr
.
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.
This corresponds to std::os::unix::net::UnixDatagram::recv_from
.
sourcepub fn recv(&self, buf: &mut [u8]) -> Result<usize>
pub fn recv(&self, buf: &mut [u8]) -> Result<usize>
Receives data from the socket.
This corresponds to std::os::unix::net::UnixDatagram::recv
.
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.
This corresponds to std::os::unix::net::UnixDatagram::send
.
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.
This corresponds to
std::os::unix::net::UnixDatagram::set_read_timeout
.
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.
This corresponds to
std::os::unix::net::UnixDatagram::set_write_timeout
.
sourcepub fn read_timeout(&self) -> Result<Option<Duration>>
pub fn read_timeout(&self) -> Result<Option<Duration>>
Returns the read timeout of this socket.
This corresponds to std::os::unix::net::UnixDatagram::read_timeout
.
sourcepub fn write_timeout(&self) -> Result<Option<Duration>>
pub fn write_timeout(&self) -> Result<Option<Duration>>
Returns the write timeout of this socket.
This corresponds to
std::os::unix::net::UnixDatagram::write_timeout
.
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.
This corresponds to
std::os::unix::net::UnixDatagram::set_nonblocking
.
sourcepub fn take_error(&self) -> Result<Option<Error>>
pub fn take_error(&self) -> Result<Option<Error>>
Returns the value of the SO_ERROR
option.
This corresponds to std::os::unix::net::UnixDatagram::take_error
.
Trait Implementations
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
sourceimpl FromFd for UnixDatagram
impl FromFd for UnixDatagram
sourceimpl FromRawFd for UnixDatagram
impl FromRawFd for UnixDatagram
sourceunsafe fn from_raw_fd(fd: RawFd) -> Self
unsafe fn from_raw_fd(fd: RawFd) -> Self
Constructs a new instance of Self
from the given raw file
descriptor. Read more
sourceimpl IntoFd for UnixDatagram
impl IntoFd for UnixDatagram
sourceimpl IntoRawFd for UnixDatagram
impl IntoRawFd for UnixDatagram
sourcefn into_raw_fd(self) -> RawFd
fn into_raw_fd(self) -> RawFd
Consumes this object, returning the raw underlying file descriptor. 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> AsFilelike for T where
T: AsFd,
impl<T> AsFilelike for T where
T: AsFd,
sourcepub fn as_filelike(&self) -> BorrowedFd<'_>
pub fn as_filelike(&self) -> BorrowedFd<'_>
Borrows the reference. Read more
sourcepub fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromFilelike + IntoFilelike,
pub fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromFilelike + IntoFilelike,
Return a borrowing view of a resource which dereferences to a &Target
or &mut Target
. Read more
sourceimpl<T> AsGrip for T where
T: AsFd,
impl<T> AsGrip for T where
T: AsFd,
sourcepub fn as_grip(&self) -> BorrowedFd<'_>
pub fn as_grip(&self) -> BorrowedFd<'_>
Extracts the grip.
sourceimpl<T> AsRawFilelike for T where
T: AsRawFd,
impl<T> AsRawFilelike for T where
T: AsRawFd,
sourcepub fn as_raw_filelike(&self) -> i32
pub fn as_raw_filelike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsRawGrip for T where
T: AsRawFd,
impl<T> AsRawGrip for T where
T: AsRawFd,
sourcepub fn as_raw_grip(&self) -> i32
pub fn as_raw_grip(&self) -> i32
Extracts the raw grip.
sourceimpl<T> AsRawSocketlike for T where
T: AsRawFd,
impl<T> AsRawSocketlike for T where
T: AsRawFd,
sourcepub fn as_raw_socketlike(&self) -> i32
pub fn as_raw_socketlike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsSocketlike for T where
T: AsFd,
impl<T> AsSocketlike for T where
T: AsFd,
sourcepub fn as_socketlike(&self) -> BorrowedFd<'_>
pub fn as_socketlike(&self) -> BorrowedFd<'_>
Borrows the reference.
sourcepub fn as_socketlike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromSocketlike + IntoSocketlike,
pub fn as_socketlike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromSocketlike + IntoSocketlike,
Return a borrowing view of a resource which dereferences to a &Target
or &mut Target
. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FromFilelike for T where
T: FromFd,
impl<T> FromFilelike for T where
T: FromFd,
sourcepub fn from_filelike(owned: OwnedFd) -> T
pub fn from_filelike(owned: OwnedFd) -> T
Constructs a new instance of Self
from the given filelike object. Read more
sourcepub fn from_into_filelike<Owned>(owned: Owned) -> T where
Owned: IntoFilelike,
pub fn from_into_filelike<Owned>(owned: Owned) -> T where
Owned: IntoFilelike,
Constructs a new instance of Self
from the given filelike object
converted from into_owned
. Read more
sourceimpl<T> FromRawFilelike for T where
T: FromRawFd,
impl<T> FromRawFilelike for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_filelike(raw: i32) -> T
pub unsafe fn from_raw_filelike(raw: i32) -> T
Constructs Self
from the raw value. Read more
sourceimpl<T> FromRawGrip for T where
T: FromRawFd,
impl<T> FromRawGrip for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_grip(raw_grip: i32) -> T
pub unsafe fn from_raw_grip(raw_grip: i32) -> T
Consume an RawGrip
and convert into a Self
. Read more
sourceimpl<T> FromRawSocketlike for T where
T: FromRawFd,
impl<T> FromRawSocketlike for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_socketlike(raw: i32) -> T
pub unsafe fn from_raw_socketlike(raw: i32) -> T
Constructs Self
from the raw value. Read more
sourceimpl<T> FromSocketlike for T where
T: FromFd,
impl<T> FromSocketlike for T where
T: FromFd,
sourcepub fn from_socketlike(owned: OwnedFd) -> T
pub fn from_socketlike(owned: OwnedFd) -> T
Constructs a new instance of Self
from the given socketlike object.
sourcepub fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,
pub fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,
Constructs a new instance of Self
from the given socketlike object
converted from into_owned
. Read more
sourceimpl<T> IntoFilelike for T where
T: IntoFd,
impl<T> IntoFilelike for T where
T: IntoFd,
sourcepub fn into_filelike(self) -> OwnedFd
pub fn into_filelike(self) -> OwnedFd
Consumes this object, returning the underlying filelike object. Read more
sourceimpl<T> IntoRawFilelike for T where
T: IntoRawFd,
impl<T> IntoRawFilelike for T where
T: IntoRawFd,
sourcepub fn into_raw_filelike(self) -> i32
pub fn into_raw_filelike(self) -> i32
Returns the raw value.
sourceimpl<T> IntoRawGrip for T where
T: IntoRawFd,
impl<T> IntoRawGrip for T where
T: IntoRawFd,
sourcepub fn into_raw_grip(self) -> i32
pub fn into_raw_grip(self) -> i32
Consume self
and convert into an RawGrip
.
sourceimpl<T> IntoSocketlike for T where
T: IntoFd,
impl<T> IntoSocketlike for T where
T: IntoFd,
sourcepub fn into_socketlike(self) -> OwnedFd
pub fn into_socketlike(self) -> OwnedFd
Consumes this object, returning the underlying socketlike object.