[−][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<I> into the I Rust object, use the .into() method.

Methods

`impl<I: Interface> Resource<I>`[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 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`[src]

Retrieve the interface version of this wayland object instance

Returns 0 on dead objects

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

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

`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<UD: 'static>(&self) -> Option<&UD>`[src]

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>`[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

Trait Implementations

`impl<I: Interface> Eq for Resource<I>`[src]

`impl<I: Interface> Clone for Resource<I>`[src]

`fn clone(&self) -> Resource<I>`[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl<I: Interface> PartialEq<Resource<I>> for Resource<I>`[src]

`fn eq(&self, other: &Resource<I>) -> bool`[src]

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

This method tests for !=.

`impl AsRef<Resource<WlCallback>> for WlCallback`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlCompositor>> for WlCompositor`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlShmPool>> for WlShmPool`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlShm>> for WlShm`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlBuffer>> for WlBuffer`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlDataOffer>> for WlDataOffer`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlDataSource>> for WlDataSource`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlDataDevice>> for WlDataDevice`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlDataDeviceManager>> for WlDataDeviceManager`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlShell>> for WlShell`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlShellSurface>> for WlShellSurface`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlSurface>> for WlSurface`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlSeat>> for WlSeat`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlPointer>> for WlPointer`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlKeyboard>> for WlKeyboard`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlTouch>> for WlTouch`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlOutput>> for WlOutput`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlRegion>> for WlRegion`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlSubcompositor>> for WlSubcompositor`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<WlSubsurface>> for WlSubsurface`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl AsRef<Resource<AnonymousObject>> for AnonymousObject`[src]

`fn as_ref(&self) -> &Resource<Self>`[src]

`impl From<Resource<WlCallback>> for WlCallback`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlCallback> for Resource<WlCallback>`[src]

`fn from(value: WlCallback) -> Self`[src]

`impl From<Resource<WlCompositor>> for WlCompositor`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlCompositor> for Resource<WlCompositor>`[src]

`fn from(value: WlCompositor) -> Self`[src]

`impl From<Resource<WlShmPool>> for WlShmPool`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlShmPool> for Resource<WlShmPool>`[src]

`fn from(value: WlShmPool) -> Self`[src]

`impl From<Resource<WlShm>> for WlShm`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlShm> for Resource<WlShm>`[src]

`fn from(value: WlShm) -> Self`[src]

`impl From<Resource<WlBuffer>> for WlBuffer`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlBuffer> for Resource<WlBuffer>`[src]

`fn from(value: WlBuffer) -> Self`[src]

`impl From<Resource<WlDataOffer>> for WlDataOffer`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlDataOffer> for Resource<WlDataOffer>`[src]

`fn from(value: WlDataOffer) -> Self`[src]

`impl From<Resource<WlDataSource>> for WlDataSource`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlDataSource> for Resource<WlDataSource>`[src]

`fn from(value: WlDataSource) -> Self`[src]

`impl From<Resource<WlDataDevice>> for WlDataDevice`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlDataDevice> for Resource<WlDataDevice>`[src]

`fn from(value: WlDataDevice) -> Self`[src]

`impl From<Resource<WlDataDeviceManager>> for WlDataDeviceManager`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlDataDeviceManager> for Resource<WlDataDeviceManager>`[src]

`fn from(value: WlDataDeviceManager) -> Self`[src]

`impl From<Resource<WlShell>> for WlShell`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlShell> for Resource<WlShell>`[src]

`fn from(value: WlShell) -> Self`[src]

`impl From<Resource<WlShellSurface>> for WlShellSurface`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlShellSurface> for Resource<WlShellSurface>`[src]

`fn from(value: WlShellSurface) -> Self`[src]

`impl From<Resource<WlSurface>> for WlSurface`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlSurface> for Resource<WlSurface>`[src]

`fn from(value: WlSurface) -> Self`[src]

`impl From<Resource<WlSeat>> for WlSeat`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlSeat> for Resource<WlSeat>`[src]

`fn from(value: WlSeat) -> Self`[src]

`impl From<Resource<WlPointer>> for WlPointer`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlPointer> for Resource<WlPointer>`[src]

`fn from(value: WlPointer) -> Self`[src]

`impl From<Resource<WlKeyboard>> for WlKeyboard`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlKeyboard> for Resource<WlKeyboard>`[src]

`fn from(value: WlKeyboard) -> Self`[src]

`impl From<Resource<WlTouch>> for WlTouch`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlTouch> for Resource<WlTouch>`[src]

`fn from(value: WlTouch) -> Self`[src]

`impl From<Resource<WlOutput>> for WlOutput`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlOutput> for Resource<WlOutput>`[src]

`fn from(value: WlOutput) -> Self`[src]

`impl From<Resource<WlRegion>> for WlRegion`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlRegion> for Resource<WlRegion>`[src]

`fn from(value: WlRegion) -> Self`[src]

`impl From<Resource<WlSubcompositor>> for WlSubcompositor`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlSubcompositor> for Resource<WlSubcompositor>`[src]

`fn from(value: WlSubcompositor) -> Self`[src]

`impl From<Resource<WlSubsurface>> for WlSubsurface`[src]

`fn from(value: Resource<Self>) -> Self`[src]

`impl From<WlSubsurface> for Resource<WlSubsurface>`[src]

`fn from(value: WlSubsurface) -> Self`[src]

`impl From<Resource<AnonymousObject>> for AnonymousObject`[src]

`fn from(resource: Resource<Self>) -> Self`[src]

`impl From<AnonymousObject> for Resource<AnonymousObject>`[src]

`fn from(value: AnonymousObject) -> Self`[src]

Auto Trait Implementations

`impl<I> Send for Resource<I> where I: Sync,`

`impl<I> Sync for Resource<I> where I: Sync,`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = !`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Downcast for T where T: Any,` [src]

`fn into_any(self: Box<T>) -> Box<dyn Any + 'static>`[src]

`fn as_any(&self) -> &(dyn Any + 'static)`[src]

`fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)`[src]