pub struct ObjectId { /* private fields */ }
Expand description

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 can confidently compare two ObjectId for equality, they will only compare as equal if they both represent the same protocol object.

Implementations

Check if this is a null ID

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.

Create a null object ID

This object ID is always invalid, and should be used as placeholder in requests that create objects, or for request with an optional Object argument.

See Backend::send_request for details.

Interface of the represented object

Return the protocol-level numerical ID of this object

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

Creates an object id from a libwayland-client pointer.

Errors

This function returns an InvalidId error if the interface of the proxy 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.

Get the underlying libwayland pointer for this object

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
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
Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.