Struct cap_std::os::unix::net::UnixDatagram[−][src]

pub struct UnixDatagram { /* fields omitted */ }

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.

Implementations

impl UnixDatagram[src]

pub fn from_std(std: UnixDatagram, _: AmbientAuthority) -> Self[src]

Constructs a new instance of Self from the given std::os::unix::net::UnixDatagram.

Ambient Authority

std::os::unix::net::UnixDatagram is not sandboxed and may access any address that the host process has access to.

pub fn unbound() -> Result<Self>[src]

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?

pub fn pair() -> Result<(Self, Self)>[src]

Creates an unnamed pair of connected sockets.

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

TODO: should this require a capability?

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

Creates a new independently owned handle to the underlying socket.

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

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

Returns the address of this socket.

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

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

Returns the address of this socket’s peer.

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

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

Receives data from the socket.

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

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

Receives data from the socket.

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

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

Sends data on the socket to the socket’s peer.

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

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

Sets the read timeout for the socket.

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

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

Sets the write timeout for the socket.

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

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

Returns the read timeout of this socket.

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

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

Returns the write timeout of this socket.

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

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

Moves the socket into or out of nonblocking mode.

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

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

Returns the value of the SO_ERROR option.

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

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

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

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

Trait Implementations

impl AsRawFd for UnixDatagram[src]

fn as_raw_fd(&self) -> RawFd[src]

Extracts the raw file descriptor. Read more

impl Debug for UnixDatagram[src]

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

Formats the value using the given formatter. Read more

impl FromRawFd for UnixDatagram[src]

unsafe fn from_raw_fd(fd: RawFd) -> Self[src]

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

impl IntoRawFd for UnixDatagram[src]

fn into_raw_fd(self) -> RawFd[src]

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

impl OwnsRaw for UnixDatagram[src]

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 T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> AsUnsafeFile for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_file(&self) -> UnsafeFile[src]

Return the contained unsafe file.

fn as_file_view(&self) -> View<'_, File>[src]

Utility for returning a value which dereferences to a &File or &mut File. Read more

unsafe fn as_unscoped_file_view(&self) -> View<'static, File>[src]

Like as_file_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn eq_file<Filelike>(&self, other: &Filelike) -> bool where
    Filelike: AsUnsafeFile,

[src]

Test whether self.as_unsafe_file().as_unsafe_handle() is equal to other.as_unsafe_file().as_unsafe_handle(). Read more

impl<T> AsUnsafeHandle for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_handle(&self) -> UnsafeHandle[src]

Return the contained unsafe handle.

fn eq_handle<Handlelike>(&self, other: &Handlelike) -> bool where
    Handlelike: AsUnsafeHandle,

[src]

Test whether self.as_unsafe_handle() is equal to other.as_unsafe_handle(). Read more

impl<T> AsUnsafeSocket for T where
    T: AsRawFd + OwnsRaw,

[src]

pub fn as_unsafe_socket(&self) -> UnsafeSocket[src]

Return the contained unsafe socket.

fn as_tcp_stream_view(&self) -> View<'_, TcpStream>[src]

Utility for returning a value which dereferences to a &TcpStream or &mut TcpStream. Read more

unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>[src]

Like as_tcp_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_tcp_listener_view(&self) -> View<'_, TcpListener>[src]

Utility for returning a value which dereferences to a &TcpListener or &mut TcpListener. Read more

unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>[src]

Like as_tcp_listener_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_udp_socket_view(&self) -> View<'_, UdpSocket>[src]

Utility for returning a value which dereferences to a &UdpSocket or &mut UdpSocket. Read more

unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>[src]

Like as_udp_socket_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn as_unix_stream_view(&self) -> View<'_, UnixStream>[src]

Utility for returning a value which dereferences to a &UnixStream or &mut UnixStream. Read more

unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>[src]

Like as_unix_stream_view, but returns a value which is not explicitly tied to the lifetime of self. Read more

fn eq_socket<Socketlike>(&self, other: &Socketlike) -> bool where
    Socketlike: AsUnsafeSocket,

[src]

Test whether self.as_unsafe_socket().as_unsafe_handle() is equal to other.as_unsafe_socket().as_unsafe_handle(). Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> FromUnsafeFile for T where
    T: FromRawFd + OwnsRaw,

[src]

pub unsafe fn from_unsafe_file(unsafe_file: UnsafeFile) -> T[src]

Convert an unsafe file into a Self. Read more

fn from_filelike<Filelike>(filelike: Filelike) -> Self where
    Filelike: IntoUnsafeFile,

[src]

Convert from a type which implements IntoUnsafeFile into a type that implements FromUnsafeFile. Read more

impl<T> FromUnsafeSocket for T where
    T: FromRawFd + OwnsRaw,

[src]

pub unsafe fn from_unsafe_socket(unsafe_socket: UnsafeSocket) -> T[src]

Convert an unsafe socket into a Self. Read more

fn from_socketlike<Socketlike>(socketlike: Socketlike) -> Self where
    Socketlike: IntoUnsafeSocket,

[src]

Convert from a type which implements IntoUnsafeSocket into a type that implements FromUnsafeSocket. Read more

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoUnsafeFile for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_file(self) -> UnsafeFile[src]

Convert self into an unsafe file.

impl<T> IntoUnsafeHandle for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_handle(self) -> UnsafeHandle[src]

Convert self into an unsafe handle.

impl<T> IntoUnsafeSocket for T where
    T: IntoRawFd + OwnsRaw,

[src]

pub fn into_unsafe_socket(self) -> UnsafeSocket[src]

Convert self into an unsafe socket.

impl<T> SetTimes for T where
    T: AsUnsafeFile,

pub 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

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.