Struct ObjectId

pub struct ObjectId { /* private fields */ }

An ID representing a Wayland object

The backend internally tracks which IDs are still valid, invalidates them when the protocol object they represent is destroyed. As such even though the Wayland protocol reuses IDs, you still confidently compare two ObjectId for equality, they will only compare as equal if they both represent the same protocol object from the same client.

Implementations

impl ObjectId

pub fn is_null(&self) -> bool

Returns whether this object is a null object.

Note: This is not the same as checking if the ID is still valid, which cannot be done without the Backend. A null ID is the ID equivalent of a null pointer: it never has been valid and never will be.

pub fn null() -> ObjectId

Returns an object id that represents a null object.

This object ID is always invalid, and should be used for events with an optional Object argument.

pub fn interface(&self) -> &'static Interface

Returns the interface of this object.

pub fn same_client_as(&self, other: &ObjectId) -> bool

Check if two object IDs are associated with the same client

Note: This may spuriously return false if one (or both) of the objects to compare is no longer valid.

pub fn protocol_id(&self) -> u32

Return the protocol-level numerical ID of this object

Protocol IDs are reused after object destruction and each client has its own ID space, so this should not be used as a unique identifier, instead use the ObjectId directly, it implements Clone, PartialEq, Eq and Hash.

impl ObjectId

pub unsafe fn from_ptr( interface: &'static Interface, ptr: *mut wl_resource, ) -> Result<ObjectId, InvalidId>

Creates an object from a C pointer.

Errors

This function returns an InvalidId error if the interface of the resource does not match the provided interface.

Safety

The provided pointer must be a valid pointer to a wl_resource and remain valid for as long as the retrieved ObjectId is used.

pub fn as_ptr(&self) -> *mut wl_resource

Returns the pointer that represents this object.

The pointer may be used to interoperate with libwayland.

Trait Implementations

impl Borrow<ObjectId> for WlBuffer

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlCallback

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlCompositor

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlDataDevice

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlDataDeviceManager

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlDataOffer

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlDataSource

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlKeyboard

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlOutput

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlPointer

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlRegion

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlSeat

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlShell

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlShellSurface

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlShm

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlShmPool

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlSubcompositor

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlSubsurface

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlSurface

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Borrow<ObjectId> for WlTouch

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObjectId

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for ObjectId

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for ObjectId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ObjectId

fn eq(&self, other: &ObjectId) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId