[−][src]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, although you're encouraged to use methods on the corresponding Rust objects instead. To convert a Resource into the I Rust object, use the .into() method.

Methods

`impl Resource where I: Interface + From<Resource> + AsRef<Resource>,` [src]

`pub fn send(&self, msg: I::Event)`[src]

Send an event through this object

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

`pub fn is_alive(&self) -> bool`[src]

Check if the object associated with this resource is still alive

Will return false if the object has been destroyed.

WHen using the use_system_lib feature, if this object was created from a raw pointer the crate cannot track its lifetime, and this method will always return true. You are responsible for only using it while it is still alive.

`pub fn version(&self) -> u32`[src]

Retrieve the interface version of this wayland object instance

Returns 0 on dead objects

`pub fn equals(&self, other: &Resource) -> bool`[src]

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

You can also use the PartialEq trait.

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

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)`[src]

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(&self) -> &UserData`[src]

Access the UserData associated to this object

Each wayland object has an associated UserData, that can store a payload of arbitrary type and is shared by all proxies of this object.

See UserData documentation for more details.

`pub fn client(&self) -> Option<Client>`[src]

Retrieve an handle to the client associated with this resource

Returns None if the resource is no longer alive.

`pub fn id(&self) -> u32`[src]

Retrieve the object id of this wayland object

`impl Resource where I: Interface + From<Resource> + AsRef<Resource>,` [src]

`pub fn is_external(&self) -> bool`[src]

Check whether this resource is managed by the library or not

See from_c_ptr for details.

NOTE: This method will panic if called while the use_system_lib feature is not activated

`pub fn c_ptr(&self) -> *mut wl_resource`[src]

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).

NOTE: This method will panic if called while the use_system_lib feature is not activated

`pub unsafe fn from_c_ptr(_ptr: *mut wl_resource) -> Self where I: From<Resource>,` [src]

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.

NOTE: This method will panic if called while the use_system_lib feature is not activated