[][src]Struct mio_uds::UnixStream

pub struct UnixStream { /* fields omitted */ }

A Unix stream socket.

This type represents a SOCK_STREAM connection of the AF_UNIX family, otherwise known as Unix domain sockets or Unix sockets. This stream is readable/writable and acts similarly to a TCP stream where reads/writes are all in order with respect to the other connected end.

Streams can either be connected to paths locally or another ephemeral socket created by the pair function.

A UnixStream implements the Read, Write, Evented, AsRawFd, IntoRawFd, and FromRawFd traits for interoperating with other I/O code.

Note that all values of this type are typically in nonblocking mode, so the read and write methods may return an error with the kind of WouldBlock, indicating that it's not ready to read/write just yet.

Methods

impl UnixStream[src]

pub fn connect<P: AsRef<Path>>(p: P) -> Result<UnixStream>[src]

Connects to the socket named by path.

The socket returned may not be readable and/or writable yet, as the connection may be in progress. The socket should be registered with an event loop to wait on both of these properties being available.

pub fn from_stream(stream: UnixStream) -> Result<UnixStream>[src]

Consumes a standard library UnixStream and returns a wrapped UnixStream compatible with mio.

The returned stream is moved into nonblocking mode and is otherwise ready to get associated with an event loop.

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

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

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

Creates a new independently owned handle to the underlying socket.

The returned UnixStream is a reference to the same stream that this object references. Both handles will read and write the same stream of data, and options set on one stream will be propogated to the other stream.

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

Returns the socket address of the local half of this connection.

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

Returns the socket address of the remote half of this connection.

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

Returns the value of the SO_ERROR option.

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

Shuts 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).

pub fn read_bufs(&self, bufs: &mut [&mut IoVec]) -> Result<usize>[src]

Read in a list of buffers all at once.

This operation will attempt to read bytes from this socket and place them into the list of buffers provided. Note that each buffer is an IoVec which can be created from a byte slice.

The buffers provided will be filled in sequentially. A buffer will be entirely filled up before the next is written to.

The number of bytes read is returned, if successful, or an error is returned otherwise. If no bytes are available to be read yet then a "would block" error is returned. This operation does not block.

pub fn write_bufs(&self, bufs: &[&IoVec]) -> Result<usize>[src]

Write a list of buffers all at once.

This operation will attempt to write a list of byte buffers to this socket. Note that each buffer is an IoVec which can be created from a byte slice.

The buffers provided will be written sequentially. A buffer will be entirely written before the next is written.

The number of bytes written is returned, if successful, or an error is returned otherwise. If the socket is not currently writable then a "would block" error is returned. This operation does not block.

Trait Implementations

impl AsRawFd for UnixStream[src]

impl Debug for UnixStream[src]

impl Evented for UnixStream[src]

impl FromRawFd for UnixStream[src]

impl IntoRawFd for UnixStream[src]

impl Read for UnixStream[src]

impl<'a> Read for &'a UnixStream[src]

impl Write for UnixStream[src]

impl<'a> Write for &'a UnixStream[src]

Auto Trait Implementations

impl RefUnwindSafe for UnixStream

impl Send for UnixStream

impl Sync for UnixStream

impl Unpin for UnixStream

impl UnwindSafe for UnixStream

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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.

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.