Struct unix_socket::UnixStream

pub struct UnixStream {
    // some fields omitted
}

A Unix stream socket.

Examples

use unix_socket::UnixStream;
use std::io::prelude::*;

let mut stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.write_all(b"hello world").unwrap();
let mut response = String::new();
stream.read_to_string(&mut response).unwrap();
println!("{}", response);

Methods

impl UnixStream

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

Connect to the socket named by path.

Linux provides, as a nonportable extension, a separate "abstract" address namespace as opposed to filesystem-based addressing. If path begins with a null byte, it will be interpreted as an "abstract" address. Otherwise, it will be interpreted as a "pathname" address, corresponding to a path on the filesystem.

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

Create an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

fn unnamed() -> Result<(UnixStream, UnixStream)>

Deprecated

Use UnixStream::pair instead.

fn try_clone(&self) -> Result<UnixStream>

Create 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 set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets the read timeout for the socket.

If the provided value is None, then read calls will block indefinitely. It is an error to pass the zero Duration to this method.

Requires the socket_timeout feature.

fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets the write timeout for the socket.

If the provided value is None, then write calls will block indefinitely. It is an error to pass the zero Duration to this method.

Requires the socket_timeout feature.

fn read_timeout(&self) -> Result<Option<Duration>>

Returns the read timeout of this socket.

Requires the socket_timeout feature.

fn write_timeout(&self) -> Result<Option<Duration>>

Returns the write timeout of this socket.

Requires the socket_timeout feature.

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

Shut 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, fmt: &mut Formatter) -> Result

impl Read for UnixStream

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

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

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

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

fn bytes(self) -> Bytes<Self>

fn chars(self) -> Chars<Self>

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

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

fn tee<W>(self, out: W) -> Tee<Self, W> where W: Write

impl<'a> Read for &'a UnixStream

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

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

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

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

fn bytes(self) -> Bytes<Self>

fn chars(self) -> Chars<Self>

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

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

fn tee<W>(self, out: W) -> Tee<Self, W> where W: Write

impl Write for UnixStream

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

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

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

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

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

fn broadcast<W>(self, other: W) -> Broadcast<Self, W> where W: Write

impl<'a> Write for &'a UnixStream

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

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

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

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

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

fn broadcast<W>(self, other: W) -> Broadcast<Self, W> where W: Write

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

impl FromRawFd for UnixStream

Requires the from_raw_fd feature (enabled by default).

unsafe fn from_raw_fd(fd: RawFd) -> UnixStream