Struct mio_uds::UnixStream
[−]
[src]
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
[src]
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 UnixStream
s 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
[src]
impl Evented for UnixStream
[src]
fn register(
&self,
poll: &Poll,
token: Token,
events: Ready,
opts: PollOpt
) -> Result<()>
&self,
poll: &Poll,
token: Token,
events: Ready,
opts: PollOpt
) -> Result<()>
Register self
with the given Poll
instance. Read more
fn reregister(
&self,
poll: &Poll,
token: Token,
events: Ready,
opts: PollOpt
) -> Result<()>
&self,
poll: &Poll,
token: Token,
events: Ready,
opts: PollOpt
) -> Result<()>
Re-register self
with the given Poll
instance. Read more
fn deregister(&self, poll: &Poll) -> Result<()>
Deregister self
from the given Poll
instance Read more
impl Read for UnixStream
[src]
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. 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> Read for &'a UnixStream
[src]
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. 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, bytes: &[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> Write for &'a UnixStream
[src]
fn write(&mut self, bytes: &[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 AsRawFd for UnixStream
[src]
impl IntoRawFd for UnixStream
[src]
fn into_raw_fd(self) -> i32
Consumes this object, returning the raw underlying file descriptor. Read more
impl FromRawFd for UnixStream
[src]
unsafe fn from_raw_fd(fd: i32) -> UnixStream
Constructs a new instance of Self
from the given raw file descriptor. Read more