Struct wayland_backend::rs::socket::BufferedSocket

pub struct BufferedSocket {
    socket: Socket,
    in_data: Buffer<u8>,
    in_fds: VecDeque<OwnedFd>,
    out_data: Buffer<u8>,
    out_fds: Vec<OwnedFd>,
}

An adapter around a raw Socket that directly handles buffering and conversion from/to wayland messages

Fields

socket: Socket

in_data: Buffer<u8>

in_fds: VecDeque<OwnedFd>

out_data: Buffer<u8>

out_fds: Vec<OwnedFd>

Implementations

impl BufferedSocket

pub fn new(socket: Socket) -> Self

Wrap a Socket into a Buffered Socket

pub fn flush(&mut self) -> IoResult<()>

Flush the contents of the outgoing buffer into the socket

fn attempt_write_message(&mut self, msg: &Message<u32, RawFd>) -> IoResult<bool>

pub fn write_message(&mut self, msg: &Message<u32, RawFd>) -> IoResult<()>

Write a message to the outgoing buffer

This method may flush the internal buffer if necessary (if it is full).

If the message is too big to fit in the buffer, the error Error::Sys(E2BIG) will be returned.

pub fn fill_incoming_buffers(&mut self) -> IoResult<()>

Try to fill the incoming buffers of this socket, to prepare a new round of parsing.

pub fn read_one_message<F>( &mut self, signature: F, ) -> Result<Message<u32, OwnedFd>, MessageParseError>

where F: FnMut(u32, u16) -> Option<&'static [ArgumentType]>,

Read and deserialize a single message from the incoming buffers socket

This method requires one closure that given an object id and an opcode, must provide the signature of the associated request/event, in the form of a &'static [ArgumentType].

Trait Implementations

impl AsFd for BufferedSocket

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

Borrows the file descriptor.

impl AsRawFd for BufferedSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for BufferedSocket

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

Formats the value using the given formatter.