Struct wayland_client::backend::Backend

pub struct Backend { /* private fields */ }

A Wayland client backend

This type hosts all the interface for interacting with the wayland protocol. It can be cloned, all clones refer to the same underlying connection.

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 downgrade(&self) -> WeakBackend

Get a WeakBackend from this backend

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

Flush all pending outgoing requests to the server

pub fn display_id(&self) -> ObjectId

Get the object ID for the wl_display

pub fn last_error(&self) -> Option<WaylandError>

Get the last error that occurred on this backend

If this returns an error, your Wayland connection is already dead.

pub fn info(&self, id: ObjectId) -> Result<ObjectInfo, InvalidId>

Get the detailed information about a wayland object

Returns an error if the provided object ID is no longer valid.

pub fn null_id() -> ObjectId

Create a null object ID

This object ID is always invalid, and can be used as placeholder.

pub fn send_request(
    &self,
    msg: Message<ObjectId>,
    data: Option<Arc<dyn ObjectData + 'static>>,
    child_spec: Option<(&'static Interface, u32)>
) -> Result<ObjectId, InvalidId>

Sends a request to the server

Returns an error if the sender ID of the provided message is no longer valid.

Panic:

Several checks against the protocol specification are done, and this method will panic if they do not pass:

• the message opcode must be valid for the sender interface
• the argument list must match the prototype for the message associated with this opcode
• if the method creates a new object, a null_id() must be given in the argument list at the appropriate place, and a child_spec (interface and version) can be provided. If one is provided, it’ll be checked agains the protocol spec.

pub fn get_data(
    &self,
    id: ObjectId
) -> Result<Arc<dyn ObjectData + 'static>, InvalidId>

Access the object data associated with a given object ID

Returns an error if the object ID is not longer valid or if it corresponds to a Wayland object that is not managed by this backend (when multiple libraries share the same Wayland socket via libwayland if using the system backend).

pub fn set_data(
    &self,
    id: ObjectId,
    data: Arc<dyn ObjectData + 'static>
) -> Result<(), InvalidId>

Set the object data associated with a given object ID

Returns an error if the object ID is not longer valid or if it corresponds to a Wayland object that is not managed by this backend (when multiple libraries share the same Wayland socket via libwayland if using the system backend).

pub fn prepare_read(&self) -> Result<ReadEventsGuard, WaylandError>

Create a new reading guard

This call will not block, but event callbacks may be invoked in the process of preparing the guard.

Trait Implementations

impl Clone for Backend

fn clone(&self) -> Backend

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Backend

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

Formats the value using the given formatter.