Struct wayland_server::Resource

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

An handle to a wayland resource

This represents a wayland object instanciated 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 is_external(&self) -> bool

Check whether this resource is managed by the library or not

See from_c_ptr for details.

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 set_user_data(&self, ptr: *mut ())

Associate an arbitrary payload to this object

The pointer you associate here can be retrieved from any other resource handle to the same wayland object.

Setting or getting user data is done as an atomic operation. You are responsible for the correct initialization of this pointer, synchronisation of access, and destruction of the contents at the appropriate time.

pub fn get_user_data(&self) -> *mut ()

Retrieve the arbitrary payload associated to this object

See set_user_data for explanations.

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 c_ptr(&self) -> *mut wl_resource

Get a raw pointer to the underlying wayland object

Retrieve a pointer to the object from the libwayland-server.so library. You will mostly need it to interface with C libraries needing access to wayland objects (to initialize an opengl context for example).

pub unsafe fn from_c_ptr(ptr: *mut wl_resource) -> Self

Create a Resource instance from a C pointer

Create a Resource from a raw pointer to a wayland object from the C library.

If the pointer was previously obtained by the c_ptr() method, this constructs a new resource handle for the same object just like the clone() method would have.

If the object was created by some other C library you are interfacing with, it will be created in an "unmanaged" state: wayland-server will treat it as foreign, and as such most of the safeties will be absent. Notably the lifetime of the object can't be tracked, so the alive() method will always return false and you are responsible of not using an object past its destruction (as this would cause a protocol error). You will also be unable to associate any user data pointer to this object.

In order to handle protocol races, invoking it with a NULL pointer will create an already-dead object.

pub fn is_implemented_with<Impl>(&self) -> bool where     Impl: Implementation<Resource<I>, I::Request> + 'static,

Check whether this resource has been implemented with given type

Always returns false if the resource is no longer alive

Trait Implementations

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

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

impl<I: Interface> PartialEq 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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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.