Struct tokio::net::UnixStream

[+] Show declaration

pub struct UnixStream { /* fields omitted */ }

[−] Expand description

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

[−]

pub fn connect<P>(path: P) -> ConnectFuture 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, associating the returned stream with the default event loop's handle.

pub fn from_std(     stream: UnixStream,     handle: &Handle ) -> Result<UnixStream, Error>

[−]

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.

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

[−]

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.

pub fn poll_read_ready(&self, ready: Ready) -> Result<Async<Ready>, Error>

[−]

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

pub fn poll_write_ready(&self) -> Result<Async<Ready>, Error>

[−]

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

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

[−]

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

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

[−]

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

pub fn peer_cred(&self) -> Result<UCred, Error>

[−]

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

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

[−]

Returns the value of the SO_ERROR option.

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

[−]

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, f: &mut Formatter) -> Result<(), Error>

[−]

Formats the value using the given formatter.

impl AsRawFd for UnixStream

[+]

fn as_raw_fd(&self) -> i32

[−]

Extracts the raw file descriptor.

impl AsyncWrite for UnixStream

[+]

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

[−]

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

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

[−]

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

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

[−]

Attempt to write bytes from buf into the object.

fn poll_flush(&mut self) -> Result<Async<()>, Error>

[−]

Attempt to flush the object, ensuring that any buffered data reach their destination.

impl<'a> AsyncWrite for &'a UnixStream

[+]

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

[−]

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

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

[−]

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

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

[−]

Attempt to write bytes from buf into the object.

fn poll_flush(&mut self) -> Result<Async<()>, Error>

[−]

Attempt to flush the object, ensuring that any buffered data reach their destination.

impl<'a> Write for &'a UnixStream

[+]

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

[−]

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

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

[−]

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.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

[−]

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

impl Write for UnixStream

[+]

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

[−]

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

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

[−]

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.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

[−]

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

impl Read for UnixStream

[+]

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

[−]

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, appending them to buf.

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

[−]

Read the exact number of bytes required to fill buf.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

[−]

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

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

[−]

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

[−]

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

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

[−]

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

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, buf: &mut [u8]) -> Result<usize, Error>

[−]

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, appending them to buf.

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

[−]

Read the exact number of bytes required to fill buf.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

[−]

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

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

[−]

Transforms this Read instance to an [Iterator] over its bytes.

Important traits for Chars<R>

impl<R> Iterator for Chars<R> where
    R: Read,  type Item = Result<char, CharsError>;

fn chars(self) -> Chars<Self>

[−]

Deprecated since 1.27.0

: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples

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

Important traits for Chain<T, U>

impl<T, U> Read for Chain<T, U> where
    T: Read,
    U: Read, 

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

[−]

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T> Read for Take<T> where
    T: Read, 

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

[−]

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

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>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where     B: BufMut,

[−]

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

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

[−]

Attempt to read from the AsyncRead into buf.

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

[−]

Deprecated since 0.1.7

: Use tokio_codec::Decoder::framed instead

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> 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>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where     B: BufMut,

[−]

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

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

[−]

Attempt to read from the AsyncRead into buf.

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

[−]

Deprecated since 0.1.7

: Use tokio_codec::Decoder::framed instead

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.