Struct tokio_uds::UnixStream

pub struct UnixStream { /* fields omitted */ }

A structure representing a connected unix socket.

This socket can be connected directly with UnixStream::connect or accepted from a listener with UnixListener::incoming. Additionally, a pair of anonymous Unix sockets can be created with UnixStream::pair.

Methods

impl UnixStream

fn connect<P>(p: P, handle: &Handle) -> Result<UnixStream> where
    P: AsRef<Path>, 

Connects to the socket named by path.

This function will create a new unix socket and connect to the path specified, performing associating the returned stream with the provided event loop's handle.

fn from_stream(stream: UnixStream, handle: &Handle) -> Result<UnixStream>

Consumes a UnixStream in the standard library and returns a nonblocking UnixStream from this crate.

The returned stream will be associated with the given event loop specified by handle and is ready to perform I/O.

fn pair(handle: &Handle) -> Result<(UnixStream, UnixStream)>

Creates an unnamed pair of connected sockets.

This function will create a pair of interconnected unix sockets for communicating back and forth between one another. Each socket will be associated with the event loop whose handle is also provided.

fn need_read(&self)

Indicates to this source of events that the corresponding I/O object is no longer readable, but it needs to be.

Panics

This function will panic if called outside the context of a future's task.

fn need_write(&self)

Indicates to this source of events that the corresponding I/O object is no longer writable, but it needs to be.

Panics

This function will panic if called outside the context of a future's task.

fn poll_read(&self) -> Async<()>

Test whether this socket is ready to be read or not.

fn poll_write(&self) -> Async<()>

Test whether this socket is ready to be written to or not.

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 peer_cred(&self) -> Result<UCred>

Returns effective credentials of the process which called connect or socketpair.

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 Read for UnixStream

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.

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.

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 [char]s.

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, buf: &[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 Io for UnixStream

fn poll_read(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be writable.

fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Read in a list of buffers all at once.

fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Write a list of buffers all at once.

fn framed<C>(self, codec: C) -> Framed<Self, C> where
    C: Codec, 

Deprecated

: moved to the tokio-io crate

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Deprecated

: moved to the tokio-io crate

Helper method for splitting this read/write object into two halves.

impl AsyncRead for UnixStream

unsafe fn prepare_uninitialized_buffer(&self, _: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn read_buf<B: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error>

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

fn framed<T>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite,
    T: Decoder + Encoder, 

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite, 

Helper method for splitting this read/write object into two halves.

impl AsyncWrite for UnixStream

fn shutdown(&mut self) -> Poll<(), Error>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn write_buf<B: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error>

Write a Buf into this value, returning how many bytes were written.

impl<'a> Read for &'a UnixStream

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.

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.

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 [char]s.

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> Write for &'a UnixStream

fn write(&mut self, buf: &[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> Io for &'a UnixStream

fn poll_read(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>

Deprecated

: moved to the tokio-io crate

Tests to see if this I/O object may be writable.

fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Read in a list of buffers all at once.

fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>

Deprecated

: moved to the tokio-io crate

Write a list of buffers all at once.

fn framed<C>(self, codec: C) -> Framed<Self, C> where
    C: Codec, 

Deprecated

: moved to the tokio-io crate

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)

Deprecated

: moved to the tokio-io crate

Helper method for splitting this read/write object into two halves.

impl<'a> AsyncRead for &'a UnixStream

unsafe fn prepare_uninitialized_buffer(&self, _: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn read_buf<B: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error>

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

fn framed<T>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite,
    T: Decoder + Encoder, 

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite, 

Helper method for splitting this read/write object into two halves.

impl<'a> AsyncWrite for &'a UnixStream

fn shutdown(&mut self) -> Poll<(), Error>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn write_buf<B: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error>

Write a Buf into this value, returning how many bytes were written.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.