Struct uds_windows::UnixStream

pub struct UnixStream(_);

A Unix stream socket

Examples

use uds_windows::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.

Examples

use uds_windows::UnixStream;

let socket = match UnixStream::connect("/tmp/sock") {
    Ok(sock) => sock,
    Err(e) => {
        println!("Couldn't connect: {:?}", e);
        return
    }
};

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 propagated to the other stream.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let sock_copy = socket.try_clone().expect("Couldn't clone socket");

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

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

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let addr = socket.local_addr().expect("Couldn't get local address");

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

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

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let addr = socket.peer_addr().expect("Couldn't get peer address");

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

Moves the socket into or out of nonblocking mode.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_nonblocking(true).expect("Couldn't set nonblocking");

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

Returns the value of the SO_ERROR option.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
if let Ok(Some(err)) = socket.take_error() {
    println!("Got error: {:?}", err);
}

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 for Shutdown).

Examples

use uds_windows::UnixStream;
use std::net::Shutdown;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.shutdown(Shutdown::Both).expect("shutdown function failed");

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

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets the read timeout to the timeout specified.

If the value specified is None, then read calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_read_timeout(None).expect("Couldn't set read timeout");

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

Sets the write timeout to the timeout specified.

If the value specified is None, then write calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_write_timeout(None).expect("Couldn't set write timeout");

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

Returns the read timeout of this socket.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_read_timeout(None).expect("Couldn't set read timeout");
assert_eq!(socket.read_timeout().unwrap(), None);

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

Returns the write timeout of this socket.

Examples

use uds_windows::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_write_timeout(None).expect("Couldn't set write timeout");
assert_eq!(socket.write_timeout().unwrap(), None);

Trait Implementations

impl AsRawSocket for UnixStream

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl FromRawSocket for UnixStream

unsafe fn from_raw_socket(sock: RawSocket) -> Self

Constructs a new I/O object from the specified raw socket.

impl IntoRawSocket for UnixStream

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

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.

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

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

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.

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.

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.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adapter which will chain this stream with another.

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

Creates an adapter 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.

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

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

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.

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.

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.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adapter which will chain this stream with another.

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

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

impl UnixStreamExt for UnixStream

unsafe fn read_overlapped(
    &self,
    buf: &mut [u8],
    overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>

Execute an overlapped read I/O operation on this Unix domain socket stream.

unsafe fn write_overlapped(
    &self,
    buf: &[u8],
    overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>

Execute an overlapped write I/O operation on this Unix domain socket stream.

unsafe fn connect_overlapped(
    &self,
    addr: &SocketAddr,
    buf: &[u8],
    overlapped: *mut OVERLAPPED
) -> Result<Option<usize>>

Attempt to consume the internal socket in this builder by executing an overlapped connect operation.

fn connect_complete(&self) -> Result<()>

Once a connect_overlapped has finished, this function needs to be called to finish the connect operation.

unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> Result<(usize, u32)>

Calls the GetOverlappedResult function to get the result of an overlapped operation for this handle.

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.

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

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

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

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

Creates a “by reference” adapter 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.

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

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

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.

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

Attempts to write an entire buffer into this writer.

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.

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

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

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

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