Struct UnixConnection 

pub struct UnixConnection { /* private fields */ }

Available on Unix and crate feature local only.

A connection on a Unix domain socket, with the same limits, deadlines, and close behaviour as TcpConnection.

let mut conn = net_io::UnixConnection::connect("/run/myapp/control.sock")?;
conn.send_all(b"status\n")?;

Implementations

impl UnixConnection

pub fn connect<P: AsRef<Path>>(path: P) -> Result<UnixConnection, NetError>

Connects to the socket at path; waits up to 10 s when its backlog is full.

Errors

NotFound (no socket, or nobody listening), PermissionDenied, TimedOut { kind: Connect }, PathTooLong, InvalidConfig { field: "path" }, Os.

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

One receive; Ok(0) means the peer closed its side.

Errors

As TcpConnection::recv.

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

Receives until buf is full.

Errors

As TcpConnection::recv_exact.

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

One send after the gate check; may be partial.

Errors

As TcpConnection::send.

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

Sends all of buf.

Errors

As TcpConnection::send_all.

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

Half-close.

Errors

Closed, Os.

pub fn close(self) -> Result<(), NetError>

Graceful close, as TcpConnection::close.

Errors

None in this version.

pub fn abort(self)

Closes at once without the graceful linger.

pub fn info(&self) -> &ConnectionInfo

What net-io knows about this connection.

pub fn id(&self) -> ConnectionId

The connection’s id.

pub fn kill_handle(&self) -> KillHandle

A handle other threads can use to abort this connection.

pub fn set_limits(&mut self, limits: Limits)

Replaces the limits from the next operation on.

pub fn set_phase(&mut self, phase: Phase)

Chooses which deadlines apply.

pub fn set_exchange_deadline(&mut self, at: Option<Instant>)

The deadline for the current exchange (None clears it).

pub fn peer_credentials(&self) -> Result<PeerCredentials, NetError>

The peer’s process, user, and group, as read when the connection was made.

Errors

Unsupported when the OS did not report them.

pub fn send_descriptors( &mut self, body: &[u8], descriptors: &[BorrowedFd<'_>], ) -> Result<(), NetError>

Sends all of body (not empty) with up to 64 descriptors attached to its first byte (SCM_RIGHTS). The descriptors stay open here; the receiver gets its own copies.

Errors

InvalidConfig (empty body, more than 64 descriptors), as UnixConnection::send.

pub fn recv_descriptors( &mut self, body: &mut [u8], into: &mut Descriptors, ) -> Result<usize, NetError>

One receive that also takes descriptors sent with the bytes, into into (descriptors it still holds are closed first). Ok(0) means the peer closed its side.

Errors

Handoff(Truncated) when the control message was cut short: every descriptor of it was closed and the connection fails, since the bytes can no longer be framed; as UnixConnection::recv.

Trait Implementations

impl AsFd for UnixConnection

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl Debug for UnixConnection

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

Formats the value using the given formatter.

impl Read for UnixConnection

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>) -> 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<'_, u8>) -> 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<'_, u8>, ) -> 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.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.

impl Write for UnixConnection

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