Struct wayland_server::Resource
source · pub struct Resource<I: Interface> { /* private fields */ }
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.
Implementations
sourceimpl<I: Interface> Resource<I>
impl<I: Interface> Resource<I>
sourcepub fn send(&self, msg: I::Event)
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.
sourcepub fn is_alive(&self) -> bool
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)
sourcepub fn version(&self) -> u32
pub fn version(&self) -> u32
Retrieve the interface version of this wayland object instance
Returns 0 on dead objects
sourcepub fn equals(&self, other: &Resource<I>) -> bool
pub fn equals(&self, other: &Resource<I>) -> bool
Check if the other resource refers to the same underlying wayland object
sourcepub fn same_client_as<II: Interface>(&self, other: &Resource<II>) -> bool
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
sourcepub fn post_error(&self, error_code: u32, msg: String)
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.
sourcepub fn user_data<UD: 'static>(&self) -> Option<&UD>
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.
Trait Implementations
sourceimpl<I: Interface> PartialEq<Resource<I>> for Resource<I>
impl<I: Interface> PartialEq<Resource<I>> for Resource<I>
impl<I: Interface> Eq for Resource<I>
Auto Trait Implementations
impl<I> !RefUnwindSafe for Resource<I>
impl<I> Send for Resource<I>where
I: Sync,
impl<I> Sync for Resource<I>where
I: Sync,
impl<I> Unpin for Resource<I>
impl<I> !UnwindSafe for Resource<I>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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 moresourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more