Struct wayland_commons::socket::Socket

pub struct Socket { /* private fields */ }

A wayland socket

Implementations

impl Socket

pub fn send_msg(&self, bytes: &[u8], fds: &[RawFd]) -> NixResult<()>

Send a single message to the socket

A single socket message can contain several wayland messages

The fds slice should not be longer than MAX_FDS_OUT, and the bytes slice should not be longer than MAX_BYTES_OUT otherwise the receiving end may lose some data.

pub fn rcv_msg(
    &self,
    buffer: &mut [u8],
    fds: &mut [RawFd]
) -> NixResult<(usize, usize)>

Receive a single message from the socket

Return the number of bytes received and the number of Fds received.

Errors with WouldBlock is no message is available.

A single socket message can contain several wayland messages.

The buffer slice should be at least MAX_BYTES_OUT long and the fds slice MAX_FDS_OUT long, otherwise some data of the received message may be lost.

pub fn opt<O: GetSockOpt>(&self, opt: O) -> NixResult<O::Val>

Retrieve the current value of the requested socket::GetSockOpt

Trait Implementations

impl AsRawFd for Socket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Socket

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

Formats the value using the given formatter.

impl Drop for Socket

fn drop(&mut self)

Executes the destructor for this type.

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.