Struct wayland_server::Resource [−][src]
pub struct Resource<I: Interface> { /* fields omitted */ }
Expand description
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<I> into the
I Rust object, use the .into() method.
Implementations
Send an event through this object
The event will be send to the client associated to this object.
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.
Retrieve the interface version of this wayland object instance
Returns 0 on dead objects
Check if the other resource refers to the same underlying wayland object
You can also use the PartialEq trait.
Check if this resource and the other belong to the same client
Always return false if either of them is dead
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.
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.
Retrieve an handle to the client associated with this resource
Returns None if the resource is no longer alive.
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
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
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
Safety
The provided pointer must be a valid pointer to a wayland object from
libwayland-client associated to the correct interface.
Trait Implementations
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Auto Trait Implementations
impl<I> !RefUnwindSafe for Resource<I>impl<I> !UnwindSafe for Resource<I>Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more