Struct WindowsUnixStream 

pub struct WindowsUnixStream { /* private fields */ }

An unix domain stream packet connection for Windows.

It requires WSA version 2.0 or 2.2 i.e Windows 10 and above.

The crate requests version 2.2 by default!

Is simular to the UnixStream but with some limitations:

• no SOCK_DGRAM or SOCK_SEQPACKET support

• Ancillary data like SCM_RIGHTS SCM_CREDENTIALS

• Autobind feature

• socketpair

Examples

let path = "server3.sock";
 
let client = WindowsUnixStream::connect(path).unwrap();
client.send(b"first").unwrap();
client.send(b"second").unwrap();

Implementations

impl WindowsUnixStream

pub fn connect<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Connects to an unix stream server listening at path.

This is a wrapper around connect_unix_addr() for convenience and compatibility with std.

pub fn connect_unix_addr(addr: &UnixSocketAddr) -> Result<Self, Error>

Connects to an unix seqpacket server listening at addr.

pub fn connect_from_to_unix_addr( from: &UnixSocketAddr, to: &UnixSocketAddr, ) -> Result<Self, Error>

Binds to an address before connecting to a listening seqpacet socket.

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

Creates a socket pair.

pub fn try_clone(&self) -> Result<Self>

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

pub fn set_no_inherit(&self, no_inh: bool) -> Result<()>

Cloexec

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

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

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

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

pub fn local_unix_addr(&self) -> Result<UnixSocketAddr, Error>

Returns the address of this side of the connection.

pub fn peer_unix_addr(&self) -> Result<UnixSocketAddr, Error>

Returns the address of the other side of the connection.

pub fn send(&self, packet: &[u8]) -> Result<usize, Error>

Sends a packet to the peer.

pub fn recv(&self, buffer: &mut [u8]) -> Result<usize, Error>

Receives a packet from the peer.

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

pub fn send_vectored(&self, bufs: Vec<IoSlice<'_>>) -> Result<usize>

Windows consumes the io::IoSlice instances, so can no logner be accessed. The io::Write borrows, but it is not correct. DO not access the slices after it were sent.

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

Returns the value of the SO_ERROR option.

This might only provide errors generated from nonblocking connect()s, which this library doesn’t support. It is therefore unlikely to be useful, but is provided for parity with stream counterpart in std.

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

Allows to shudown receiving/sending or both sides.

Trait Implementations

impl AsRawSocket for WindowsUnixStream

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket.

impl AsSocket for WindowsUnixStream

fn as_socket(&self) -> BorrowedSocket<'_>

Borrows the socket.

impl Debug for WindowsUnixStream

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

Formats the value using the given formatter.

impl From<OwnedSocket> for WindowsUnixStream

fn from(os: OwnedSocket) -> Self

Converts to this type from the input type.

impl From<WindowsUnixStream> for OwnedSocket

fn from(value: WindowsUnixStream) -> Self

Converts to this type from the input type.

impl FromRawSocket for WindowsUnixStream

unsafe fn from_raw_socket(sock: RawSocket) -> Self

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

impl IntoRawSocket for WindowsUnixStream

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

impl Read for WindowsUnixStream

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>

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>) -> Result<usize, Error>

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> 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, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl Write for WindowsUnixStream

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

Do not access bufs after sending!

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

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

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

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

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, args: Arguments<'_>) -> Result<(), Error>

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

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

where Self: Sized,

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

impl<ESSR: EsInterfaceRegistry> XioEventPipe<ESSR> for WindowsUnixStream

fn connect_event_pipe( &mut self, ess: &XioRegistry<ESSR>, ev_uid: XioEventUid, channel: XioChannel, ) -> XioResult<()>

Should connect the self to the endpoint which is provided by the argument ess.

fn modify_event_pipe( &mut self, ess: &XioRegistry<ESSR>, ev_uid: XioEventUid, channel: XioChannel, ) -> XioResult<()>

This interface function should be reimplemented soon.

fn disconnect_event_pipe(&mut self, ess: &XioRegistry<ESSR>) -> XioResult<()>

Should disconnect self from the ess provided endpoint. An instance which implements the logic should check that the ess matches the ess used when self was initially registered (if available).