Struct UdStream

Source

pub struct UdStream { /* private fields */ }

Available on Unix only.

Expand description

A Unix domain socket byte stream, obtained either from UdStreamListener or by connecting to an existing server.

§Examples

Basic example:

use interprocess::os::unix::udsocket::UdStream;
use std::io::prelude::*;

let mut conn = UdStream::connect("/tmp/example1.sock")?;
conn.write_all(b"Hello from client!")?;
let mut string_buffer = String::new();
conn.read_to_string(&mut string_buffer)?;
println!("Server answered: {}", string_buffer);

Implementations§

Source §

impl UdStream

Source

pub fn connect<'a>(path: impl ToUdSocketPath<'a>) -> Result<Self>

Connects to a Unix domain socket server at the specified path.

See ToUdSocketPath for an example of using various string types to specify socket paths.

§System calls

socket
connect

Source

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

Receives bytes from the socket stream.

§System calls

read

Source

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

Receives bytes from the socket stream, making use of scatter input for the main data.

§System calls

readv

Source

pub fn recv_ancillary<'a: 'b, 'b>( &self, buf: &mut [u8], abuf: &'b mut AncillaryDataBuf<'a>, ) -> Result<(usize, usize)>

Receives both bytes and ancillary data from the socket stream.

The ancillary data buffer is automatically converted from the supplied value, if possible. For that reason, mutable slices of bytes (u8 values) can be passed directly.

§System calls

recvmsg

Source

pub fn recv_ancillary_vectored<'a: 'b, 'b>( &self, bufs: &mut [IoSliceMut<'_>], abuf: &'b mut AncillaryDataBuf<'a>, ) -> Result<(usize, usize)>

Receives bytes and ancillary data from the socket stream, making use of scatter input for the main data.

The ancillary data buffer is automatically converted from the supplied value, if possible. For that reason, mutable slices of bytes (u8 values) can be passed directly.

§System calls

recvmsg

Source

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

Sends bytes into the socket stream.

§System calls

write

Source

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

Sends bytes into the socket stream, making use of gather output for the main data.

§System calls

senv

Source

pub fn send_ancillary<'a>( &self, buf: &[u8], ancillary_data: impl IntoIterator<Item = AncillaryData<'a>>, ) -> Result<(usize, usize)>

Sends bytes and ancillary data into the socket stream.

The ancillary data buffer is automatically converted from the supplied value, if possible. For that reason, slices and Vecs of AncillaryData can be passed directly.

§System calls

sendmsg

Source

pub fn send_ancillary_vectored<'a>( &self, bufs: &[IoSlice<'_>], ancillary_data: impl IntoIterator<Item = AncillaryData<'a>>, ) -> Result<(usize, usize)>

Sends bytes and ancillary data into the socket stream, making use of gather output for the main data.

The ancillary data buffer is automatically converted from the supplied value, if possible. For that reason, slices and Vecs of AncillaryData can be passed directly.

§System calls

sendmsg

Source

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

Shuts down the read, write, or both halves of the stream. See Shutdown.

Attempting to call this method with the same how argument multiple times may return Ok(()) every time or it may return an error the second time it is called, depending on the platform. You must either avoid using the same value twice or ignore the error entirely.

Source

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

Enables or disables the nonblocking mode for the stream. By default, it is disabled.

In nonblocking mode, calls to the recv… methods and the Read trait methods will never wait for at least one byte of data to become available; calls to send… methods and the Write trait methods will never wait for the other side to remove enough bytes from the buffer for the write operation to be performed. Those operations will instead return a WouldBlock error immediately, allowing the thread to perform other useful operations in the meantime.

Source

pub fn is_nonblocking(&self) -> Result<bool>

Checks whether the stream is currently in nonblocking mode or not.

Source

pub fn get_peer_credentials(&self) -> Result<ucred>

Available on Linux and (GNU or musl or target_env="musleabi" or target_env="musleabihf"), or Emscripten, or Redox, or Haiku only.

Fetches the credentials of the other end of the connection without using ancillary data. The returned structure contains the process identifier, user identifier and group identifier of the peer.