Struct fd_queue::mio::UnixStream

pub struct UnixStream { /* fields omitted */ }

A non-blocking Unix stream socket with support for passing RawFd.

Implementations

impl UnixStream

pub fn connect(path: impl AsRef<Path>) -> Result<UnixStream>

Connects to the socket named by path.

Note that this is synchronous.

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

Creates an unnamed pair of connected sockets.

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

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

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

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

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

Returns the value of the SO_ERROR option.

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

Shuts down the read, write, or both halves of the 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 AsRawFd for UnixStream

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl DequeueFd for UnixStream

pub fn dequeue(&mut self) -> Option<RawFd>

Dequeue a previouly transmitted RawFd.

impl EnqueueFd for UnixStream

pub fn enqueue(&mut self, fd: &impl AsRawFd) -> Result<(), QueueFullError>

Enqueue fd for later tranmission to a different process.

impl Evented for UnixStream

pub fn register(
    &self,
    registry: &Poll,
    token: Token,
    interests: Ready,
    opts: PollOpt
) -> Result<()>

Register self with the given Poll instance.

pub fn reregister(
    &self,
    registry: &Poll,
    token: Token,
    interests: Ready,
    opts: PollOpt
) -> Result<()>

Re-register self with the given Poll instance.

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

Deregister self from the given Poll instance

impl FromRawFd for UnixStream

Create a UnixStream from a RawFd.

This does not change the RawFd into non-blocking mode. It assumes that any such required change has already been done.

pub unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for UnixStream

pub fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for UnixStream

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

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

pub fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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

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

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl TryFrom<UnixStream> for UnixStream

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(inner: StdUnixStream) -> Result<UnixStream>

Performs the conversion.

impl Write for UnixStream

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

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

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

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

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

pub fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

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

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

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