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

fn connect<P: AsRef<Path>>(p: P) -> Result<UnixStream>

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.

fn from_stream(stream: UnixStream) -> Result<UnixStream>

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.

fn pair() -> Result<(UnixStream, UnixStream)>

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

fn try_clone(&self) -> Result<UnixStream>

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.

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

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

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

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

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

Returns the value of the SO_ERROR option.

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

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

Trait Implementations

impl Debug for UnixStream

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Evented for UnixStream

fn register(&self,
            poll: &Poll,
            token: Token,
            events: Ready,
            opts: PollOpt)
            -> Result<()>

Register self with the given Poll instance.

fn reregister(&self,
              poll: &Poll,
              token: Token,
              events: Ready,
              opts: PollOpt)
              -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance

impl Read for UnixStream

fn read(&mut self, bytes: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API.   (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<'a> Read for &'a UnixStream

fn read(&mut self, bytes: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API.   (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Write for UnixStream

fn write(&mut self, bytes: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<'a> Write for &'a UnixStream

fn write(&mut self, bytes: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl IntoRawFd for UnixStream

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor.

impl FromRawFd for UnixStream

unsafe fn from_raw_fd(fd: i32) -> UnixStream

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