Struct wayland_client::backend::Backend

pub struct Backend { /* fields omitted */ }

A pure rust implementation of a Wayland client backend

This type hosts the plumbing functionalities for interacting with the wayland protocol, and most of the protocol-level interactions are made through the Handle type, accessed via the handle() method.

Implementations

impl Backend

pub fn connect(stream: UnixStream) -> Result<Backend, NoWaylandLib>

Try to initialize a Wayland backend on the provided unix stream

The provided stream should correspond to an already established unix connection with the Wayland server. On this rust backend, this method never fails.

pub fn flush(&mut self) -> Result<(), WaylandError>

Flush all pending outgoing requests to the server

pub fn dispatch_events(&mut self) -> Result<usize, WaylandError>

Read events from the wayland socket if available, and invoke the associated callbacks

This function will never block, and returns an I/O WouldBlock error if no event is available to read.

Note: this function should only be used if you know that you are the only thread reading events from the wayland socket. If this may not be the case, see ReadEventsGuard

pub fn handle(&mut self) -> &mut Handle

Access the Handle associated with this backend

Trait Implementations

impl Debug for Backend

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

Formats the value using the given formatter.