Struct cap_std::os::unix::net::UnixDatagram

source ·

pub struct UnixDatagram { /* private fields */ }

Available on Unix only.

Expand description

A Unix datagram socket.

This corresponds to std::os::unix::net::UnixDatagram.

This UnixDatagram has no bind, connect, or send_to methods. To create a UnixDatagram, 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.

Implementations

source

impl UnixDatagram

source

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.

source

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?

source

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?

source

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.

source

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the address of this socket.

This corresponds to std::os::unix::net::UnixDatagram::local_addr.

source

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.

source

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.

source

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receives data from the socket.

This corresponds to std::os::unix::net::UnixDatagram::recv.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shut down the read, write, or both halves of this connection.

This corresponds to std::os::unix::net::UnixDatagram::shutdown.

Trait Implementations

source

impl AsFd for UnixDatagram

source

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor. Read more

source

impl AsRawFd for UnixDatagram

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl Debug for UnixDatagram

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl From<OwnedFd> for UnixDatagram

source

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

source

impl From<UnixDatagram> for OwnedFd

source

fn from(datagram: UnixDatagram) -> OwnedFd

Converts to this type from the input type.

source

impl FromRawFd for UnixDatagram

source

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor. Read more

source

impl IntoRawFd for UnixDatagram

source

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

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> AsFilelike for Twhere
T: AsFd,

source

fn as_filelike(&self) -> BorrowedFd<'_>

Borrows the reference. Read more

source

fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
Target: FilelikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more

source

impl<T> AsGrip for Twhere
T: AsFd,

source

fn as_grip(&self) -> BorrowedFd<'_>

Extracts the grip.

source

impl<T> AsRawFilelike for Twhere
T: AsRawFd,

source

fn as_raw_filelike(&self) -> i32

Returns the raw value.

source

impl<T> AsRawGrip for Twhere
T: AsRawFd,

source

fn as_raw_grip(&self) -> i32

Extracts the raw grip.

source

impl<T> AsRawSocketlike for Twhere
T: AsRawFd,

source

fn as_raw_socketlike(&self) -> i32

Returns the raw value.

source

impl<T> AsSocketlike for Twhere
T: AsFd,

source

fn as_socketlike(&self) -> BorrowedFd<'_>

Borrows the reference.

source

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where
Target: SocketlikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FromFd for Twhere
T: From<OwnedFd>,

source

fn from_fd(owned_fd: OwnedFd) -> T

👎Deprecated since 1.0.0: FromFd::from_fd is replaced by From<OwnedFd>::from

Constructs a new instance of Self from the given file descriptor. Read more

source

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere
Owned: Into<OwnedFd>,
Self: Sized + From<OwnedFd>,

Constructs a new instance of Self from the given file descriptor converted from into_owned. Read more

source

impl<T> FromFilelike for Twhere
T: From<OwnedFd>,

source

fn from_filelike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given filelike object. Read more

source

fn from_into_filelike<Owned>(owned: Owned) -> Twhere
Owned: IntoFilelike,

Constructs a new instance of Self from the given filelike object converted from into_owned. Read more

source

impl<T> FromGrip for Twhere
T: From<OwnedFd>,

source

fn from_grip(owned_grip: OwnedFd) -> T

Consume an OwnedGrip and convert into a Self.

source

impl<T> FromRawFilelike for Twhere
T: FromRawFd,

source

unsafe fn from_raw_filelike(raw: i32) -> T

Constructs Self from the raw value. Read more

source

impl<T> FromRawGrip for Twhere
T: FromRawFd,

source

unsafe fn from_raw_grip(raw_grip: i32) -> T

Consume an RawGrip and convert into a Self. Read more

source

impl<T> FromRawSocketlike for Twhere
T: FromRawFd,

source

unsafe fn from_raw_socketlike(raw: i32) -> T

Constructs Self from the raw value. Read more

source

impl<T> FromSocketlike for Twhere
T: From<OwnedFd>,

source

fn from_socketlike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given socketlike object.

source

fn from_into_socketlike<Owned>(owned: Owned) -> Twhere
Owned: IntoSocketlike,

Constructs a new instance of Self from the given socketlike object converted from into_owned. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IntoFd for Twhere
OwnedFd: From<T>,

source

fn into_fd(self) -> OwnedFd

👎Deprecated since 1.0.0: IntoFd is replaced by From<...> for OwnedFd or Into<OwnedFd>

Consumes this object, returning the underlying file descriptor. Read more

source

impl<T> IntoFilelike for Twhere
T: Into<OwnedFd>,

source

fn into_filelike(self) -> OwnedFd

Consumes this object, returning the underlying filelike object. Read more

source

impl<T> IntoGrip for Twhere
T: Into<OwnedFd>,

source

fn into_grip(self) -> OwnedFd

Consume self and convert into an OwnedGrip.

source

impl<T> IntoRawFilelike for Twhere
T: IntoRawFd,

source

fn into_raw_filelike(self) -> i32

Returns the raw value.

source

impl<T> IntoRawGrip for Twhere
T: IntoRawFd,

source

fn into_raw_grip(self) -> i32

Consume self and convert into an RawGrip.

source

impl<T> IntoRawSocketlike for Twhere
T: IntoRawFd,

source

fn into_raw_socketlike(self) -> i32

Returns the raw value.

source

impl<T> IntoSocketlike for Twhere
T: Into<OwnedFd>,

source

fn into_socketlike(self) -> OwnedFd

Consumes this object, returning the underlying socketlike object.

impl<T> SetTimes for Twhere
T: AsFilelike,

fn set_times(
 &self,
 atime: Option<SystemTimeSpec>,
 mtime: Option<SystemTimeSpec>
) -> Result<(), Error>

Set the last access and last modification timestamps of an open file handle. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct cap_std::os::unix::net::UnixDatagram

Implementations

impl UnixDatagram

pub fn from_std(std: UnixDatagram) -> Self

pub fn unbound() -> Result<Self>

pub fn pair() -> Result<(Self, Self)>

pub fn try_clone(&self) -> Result<Self>

pub fn local_addr(&self) -> Result<SocketAddr>

pub fn peer_addr(&self) -> Result<SocketAddr>

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

pub fn send(&self, buf: &[u8]) -> Result<usize>

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>

pub fn read_timeout(&self) -> Result<Option<Duration>>

pub fn write_timeout(&self) -> Result<Option<Duration>>

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

pub fn take_error(&self) -> Result<Option<Error>>

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Trait Implementations

impl AsFd for UnixDatagram

fn as_fd(&self) -> BorrowedFd<'_>

impl AsRawFd for UnixDatagram

fn as_raw_fd(&self) -> RawFd

impl Debug for UnixDatagram

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl From<OwnedFd> for UnixDatagram

fn from(fd: OwnedFd) -> Self

impl From<UnixDatagram> for OwnedFd

fn from(datagram: UnixDatagram) -> OwnedFd

impl FromRawFd for UnixDatagram

unsafe fn from_raw_fd(fd: RawFd) -> Self

impl IntoRawFd for UnixDatagram

fn into_raw_fd(self) -> RawFd

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

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AsFilelike for Twhere T: AsFd,

fn as_filelike(&self) -> BorrowedFd<'_>

fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where Target: FilelikeViewType,

impl<T> AsGrip for Twhere T: AsFd,

fn as_grip(&self) -> BorrowedFd<'_>

impl<T> AsRawFilelike for Twhere T: AsRawFd,

fn as_raw_filelike(&self) -> i32

impl<T> AsRawGrip for Twhere T: AsRawFd,

fn as_raw_grip(&self) -> i32

impl<T> AsRawSocketlike for Twhere T: AsRawFd,

fn as_raw_socketlike(&self) -> i32

impl<T> AsSocketlike for Twhere T: AsFd,

fn as_socketlike(&self) -> BorrowedFd<'_>

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where Target: SocketlikeViewType,

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromFd for Twhere T: From<OwnedFd>,

fn from_fd(owned_fd: OwnedFd) -> T

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere Owned: Into<OwnedFd>, Self: Sized + From<OwnedFd>,

impl<T> FromFilelike for Twhere T: From<OwnedFd>,

fn from_filelike(owned: OwnedFd) -> T

fn from_into_filelike<Owned>(owned: Owned) -> Twhere Owned: IntoFilelike,

impl<T> FromGrip for Twhere T: From<OwnedFd>,

fn from_grip(owned_grip: OwnedFd) -> T

impl<T> FromRawFilelike for Twhere T: FromRawFd,

unsafe fn from_raw_filelike(raw: i32) -> T

impl<T> FromRawGrip for Twhere T: FromRawFd,

unsafe fn from_raw_grip(raw_grip: i32) -> T

impl<T> FromRawSocketlike for Twhere T: FromRawFd,

unsafe fn from_raw_socketlike(raw: i32) -> T

impl<T> FromSocketlike for Twhere T: From<OwnedFd>,

fn from_socketlike(owned: OwnedFd) -> T

fn from_into_socketlike<Owned>(owned: Owned) -> Twhere Owned: IntoSocketlike,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> AsFilelike for Twhere
T: AsFd,

fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
Target: FilelikeViewType,

impl<T> AsGrip for Twhere
T: AsFd,

impl<T> AsRawFilelike for Twhere
T: AsRawFd,

impl<T> AsRawGrip for Twhere
T: AsRawFd,

impl<T> AsRawSocketlike for Twhere
T: AsRawFd,

impl<T> AsSocketlike for Twhere
T: AsFd,

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where
Target: SocketlikeViewType,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> FromFd for Twhere
T: From<OwnedFd>,

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere
Owned: Into<OwnedFd>,
Self: Sized + From<OwnedFd>,

impl<T> FromFilelike for Twhere
T: From<OwnedFd>,

fn from_into_filelike<Owned>(owned: Owned) -> Twhere
Owned: IntoFilelike,

impl<T> FromGrip for Twhere
T: From<OwnedFd>,

impl<T> FromRawFilelike for Twhere
T: FromRawFd,

impl<T> FromRawGrip for Twhere
T: FromRawFd,

impl<T> FromRawSocketlike for Twhere
T: FromRawFd,

impl<T> FromSocketlike for Twhere
T: From<OwnedFd>,

fn from_into_socketlike<Owned>(owned: Owned) -> Twhere
Owned: IntoSocketlike,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> IntoFd for Twhere
OwnedFd: From<T>,

impl<T> IntoFilelike for Twhere
T: Into<OwnedFd>,

impl<T> IntoGrip for Twhere
T: Into<OwnedFd>,

impl<T> IntoRawFilelike for Twhere
T: IntoRawFd,

impl<T> IntoRawGrip for Twhere
T: IntoRawFd,

impl<T> IntoRawSocketlike for Twhere
T: IntoRawFd,

impl<T> IntoSocketlike for Twhere
T: Into<OwnedFd>,

impl<T> SetTimes for Twhere
T: AsFilelike,

fn set_times(
&self,
atime: Option<SystemTimeSpec>,
mtime: Option<SystemTimeSpec>
) -> Result<(), Error>

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,