Struct tiny_nix_ipc::Socket

pub struct Socket { /* fields omitted */ }

Methods

impl Socket

pub fn new_socketpair() -> Result<(Socket, Socket)>

Creates a socket pair (AF_UNIX/SOCK_SEQPACKET).

Both sockets are close-on-exec by default.

pub fn no_cloexec(&mut self) -> Result<()>

Disables close-on-exec on the socket (to preserve it across process forks).

pub fn recv_into_iovec<F: Default + AsMut<[RawFd]>>(
    &mut self,
    iov: &[IoVec<&mut [u8]>]
) -> Result<(usize, Option<F>)>

Reads bytes from the socket into the given scatter/gather array.

If file descriptors were passed, returns them too. To receive file descriptors, you need to instantiate the type parameter F as [RawFd; n], where n is the number of descriptors you want to receive.

Received file descriptors are set close-on-exec.

pub fn recv_into_slice<F: Default + AsMut<[RawFd]>>(
    &mut self,
    buf: &mut [u8]
) -> Result<(usize, Option<F>)>

Reads bytes from the socket into the given buffer.

If file descriptors were passed, returns them too. To receive file descriptors, you need to instantiate the type parameter F as [RawFd; n], where n is the number of descriptors you want to receive.

Received file descriptors are set close-on-exec.

pub fn recv_into_buf<F: Default + AsMut<[RawFd]>>(
    &mut self,
    buf_size: usize
) -> Result<(usize, Vec<u8>, Option<F>)>

Reads bytes from the socket into a new buffer.

If file descriptors were passed, returns them too. To receive file descriptors, you need to instantiate the type parameter F as [RawFd; n], where n is the number of descriptors you want to receive.

Received file descriptors are set close-on-exec.

pub fn recv_into_buf_with_len<F: Default + AsMut<[RawFd]>>(
    &mut self,
    buf_size: usize
) -> Result<(usize, Vec<u8>, u64, Option<F>)>

Reads bytes from the socket into a new buffer, also reading the first 64 bits as length. The resulting buffer is truncated to that length.

If file descriptors were passed, returns them too. To receive file descriptors, you need to instantiate the type parameter F as [RawFd; n], where n is the number of descriptors you want to receive.

Received file descriptors are set close-on-exec.

pub unsafe fn recv_struct_raw<T, F: Default + AsMut<[RawFd]>>(
    &mut self
) -> Result<(T, Option<F>)>

See recv_struct for docs

Safety

• For some types (e.g.), not every bit pattern is allowed. If bytes, read from socket aren't correct, that's UB.
• Some types mustn't change their memory location (see std::pin::Pin). Sending object of such a type is UB.

pub fn send_iovec(
    &mut self,
    iov: &[IoVec<&[u8]>],
    fds: Option<&[RawFd]>
) -> Result<usize>

Sends bytes from scatter-gather vectors over the socket.

Optionally passes file descriptors with the message.

pub fn send_slice(
    &mut self,
    data: &[u8],
    fds: Option<&[RawFd]>
) -> Result<usize>

Sends bytes from a slice over the socket.

Optionally passes file descriptors with the message.

pub fn send_slice_with_len(
    &mut self,
    data: &[u8],
    fds: Option<&[RawFd]>
) -> Result<usize>

Sends bytes from a slice over the socket, prefixing with the length (as a 64-bit unsigned integer).

Optionally passes file descriptors with the message.

pub unsafe fn send_struct_raw<T>(
    &mut self,
    data: &T,
    fds: Option<&[RawFd]>
) -> Result<usize>

See send_struct for docs.

Safety

• T must not have padding bytes.
• Also, if T violates recv_struct_raw safety preconditions, receiving it will trigger undefined behavior.

Trait Implementations

impl Drop for Socket

fn drop(&mut self)

Executes the destructor for this type.

impl AsRawFd for Socket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for Socket

unsafe fn from_raw_fd(fd: RawFd) -> Socket

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

impl IntoRawFd for Socket

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.