Struct unix_socket::UnixStream

pub struct UnixStream { /* 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);

Implementations

impl UnixStream

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

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();

pub fn connect_timeout<P: AsRef<Path>>(
    path: P,
    timeout: Duration
) -> Result<UnixStream>

As connect, but time out after a specified duration.

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

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

Examples

use unix_socket::UnixStream;

let (stream1, stream2) = UnixStream::pair().unwrap();

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
let copy = stream.try_clone().unwrap();

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

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.local_addr() {
    Ok(addr) => format!("local address: {:?}", addr),
    Err(_) => "no local address".to_owned(),
});

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

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.peer_addr() {
    Ok(addr) => format!("peer address: {:?}", addr),
    Err(_) => "no peer address".to_owned(),
});

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

Examples

use unix_socket::UnixStream;
use std::time::Duration;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_read_timeout(Some(Duration::from_millis(1500))).unwrap();

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

Examples

use unix_socket::UnixStream;
use std::time::Duration;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_write_timeout(Some(Duration::from_millis(1500))).unwrap();

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

Returns the read timeout of this socket.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.read_timeout() {
    Ok(timeout) => format!("read timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

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

Returns the write timeout of this socket.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.write_timeout() {
    Ok(timeout) => format!("write timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Moves the socket into or out of nonblocking mode.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_nonblocking(true).unwrap();

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

Returns the value of the SO_ERROR option.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.take_error() {
    Ok(ret) => format!("error: {:?}", ret),
    Err(_) => "error".to_owned(),
});

pub 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).

Examples

use std::net::Shutdown;
use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.shutdown(Shutdown::Both).unwrap();

Trait Implementations

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixStream

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRawFd for UnixStream

unsafe fn from_raw_fd(fd: RawFd) -> UnixStream

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for UnixStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

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.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

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

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

Read all bytes until EOF in this source, placing them into buf.

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

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

pub 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>

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

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

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

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

Read all bytes until EOF in this source, placing them into buf.

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

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

pub 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 writer, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

pub fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

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

Creates a “by reference” adaptor for this instance of Write.

impl<'a> Write for &'a UnixStream

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

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

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

pub fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

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

Creates a “by reference” adaptor for this instance of Write.