Struct wayland_server::Resource

pub struct Resource<I: Interface> { /* fields omitted */ }

An handle to a wayland resource

This represents a wayland object instantiated in a client session. Several handles to the same object can exist at a given time, and cloning them won't create a new protocol object, only clone the handle. The lifetime of the protocol object is not tied to the lifetime of these handles, but rather to sending or receiving destroying messages.

These handles are notably used to send events to the associated client, via the send method.

Methods

impl<I: Interface> Resource<I>

pub fn send(&self, msg: I::Event)

Send an event through this object

The event will be send to the client associated to this object.

pub fn is_alive(&self) -> bool

Check if the object associated with this resource is still alive

Will return false if either:

• The object has been destroyed
• The object is not managed by this library (see the from_c_ptr method)

pub fn version(&self) -> u32

Retrieve the interface version of this wayland object instance

Returns 0 on dead objects

pub fn equals(&self, other: &Resource<I>) -> bool

Check if the other resource refers to the same underlying wayland object

pub fn same_client_as<II: Interface>(&self, other: &Resource<II>) -> bool

Check if this resource and the other belong to the same client

Always return false if either of them is dead

pub fn post_error(&self, error_code: u32, msg: String)

Posts a protocol error to this resource

The error code can be obtained from the various Error enums of the protocols.

An error is fatal to the client that caused it.

pub fn user_data<UD: 'static>(&self) -> Option<&UD>

Access the arbitrary payload associated to this object

You need to specify the expected type of this payload, and this function will return None if either the types don't match or you are attempting to access a non Send + Sync user data from the wrong thread.

This value is associated to the Resource when you implement it, and you cannot access it mutably afterwards. If you need interior mutability, you are responsible for using a Mutex or similar type to achieve it.

pub fn client(&self) -> Option<Client>

Retrieve an handle to the client associated with this resource

Returns None if the resource is no longer alive.

pub fn id(&self) -> u32

Retrieve the object id of this wayland object

Trait Implementations

impl<I: Interface> Eq for Resource<I>

impl<I: Interface> PartialEq<Resource<I>> for Resource<I>

fn eq(&self, other: &Resource<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<I: Interface> Clone for Resource<I>

fn clone(&self) -> Resource<I>

Returns a copy of the value.

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

Performs copy-assignment from source.