Struct tokio_uds::UnixStream
[−]
[src]
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
[src]
fn connect<P>(p: P, handle: &Handle) -> Result<UnixStream> where
P: AsRef<Path>,
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 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 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
[src]
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. Read more
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
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. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Io for UnixStream
[src]
fn poll_read(&mut self) -> Async<()>
: moved to the tokio-io
crate
Tests to see if this I/O object may be readable. Read more
fn poll_write(&mut self) -> Async<()>
: moved to the tokio-io
crate
Tests to see if this I/O object may be writable. Read more
fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>
: moved to the tokio-io
crate
Read in a list of buffers all at once. Read more
fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>
: moved to the tokio-io
crate
Write a list of buffers all at once. Read more
fn framed<C>(self, codec: C) -> Framed<Self, C> where
C: Codec,
C: Codec,
: 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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)
: moved to the tokio-io
crate
Helper method for splitting this read/write object into two halves. Read more
impl AsyncRead for UnixStream
[src]
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. Read more
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. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl AsyncWrite for UnixStream
[src]
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. Read more
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. Read more
impl<'a> Read for &'a UnixStream
[src]
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. Read more
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
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. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<'a> Write for &'a UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<'a> Io for &'a UnixStream
[src]
fn poll_read(&mut self) -> Async<()>
: moved to the tokio-io
crate
Tests to see if this I/O object may be readable. Read more
fn poll_write(&mut self) -> Async<()>
: moved to the tokio-io
crate
Tests to see if this I/O object may be writable. Read more
fn read_vec(&mut self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>
: moved to the tokio-io
crate
Read in a list of buffers all at once. Read more
fn write_vec(&mut self, bufs: &[&IoVec]) -> Result<usize, Error>
: moved to the tokio-io
crate
Write a list of buffers all at once. Read more
fn framed<C>(self, codec: C) -> Framed<Self, C> where
C: Codec,
C: Codec,
: 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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)
: moved to the tokio-io
crate
Helper method for splitting this read/write object into two halves. Read more
impl<'a> AsyncRead for &'a UnixStream
[src]
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. Read more
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. Read more
fn framed<T>(self, codec: T) -> Framed<Self, T> where
Self: AsyncWrite,
T: Decoder + Encoder,
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. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more
impl<'a> AsyncWrite for &'a UnixStream
[src]
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. Read more
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. Read more