Struct WpDrmLeaseConnectorV1

pub struct WpDrmLeaseConnectorV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

a leasable DRM connector

Represents a DRM connector which is available for lease. These objects are created via wp_drm_lease_device_v1.connector events, and should be passed to lease requests via wp_drm_lease_request_v1.request_connector. Immediately after the wp_drm_lease_connector_v1 object is created the compositor will send a name, a description, a connector_id and a done event. When the description is updated the compositor will send a description event followed by a done event.

See also the Request enum for this interface.

Implementations

impl WpDrmLeaseConnectorV1

pub fn name(&self, name: String)

name

The compositor sends this event once the connector is created to indicate the name of this connector. This will not change for the duration of the Wayland session, but is not guaranteed to be consistent between sessions.

If the compositor supports wl_output version 4 and this connector corresponds to a wl_output, the compositor should use the same name as for the wl_output.

pub fn description(&self, description: String)

description

The compositor sends this event once the connector is created to provide a human-readable description for this connector, which may be presented to the user. The compositor may send this event multiple times over the lifetime of this object to reflect changes in the description.

pub fn connector_id(&self, connector_id: u32)

connector_id

The compositor sends this event once the connector is created to indicate the DRM object ID which represents the underlying connector that is being offered. Note that the final lease may include additional object IDs, such as CRTCs and planes.

pub fn done(&self)

all properties have been sent

This event is sent after all properties of a connector have been sent. This allows changes to the properties to be seen as atomic even if they happen via multiple events.

pub fn withdrawn(&self)

lease offer withdrawn

Sent to indicate that the compositor will no longer honor requests for DRM leases which include this connector. The client may still issue a lease request including this connector, but the compositor will send wp_drm_lease_v1.finished without issuing a lease fd. Compositors are encouraged to send this event when they lose access to connector, for example when the connector is hot-unplugged, when the connector gets leased to a client or when the compositor loses DRM master.

If a client holds a lease for the connector, the status of the lease remains the same. The client should destroy the object after receiving this event.

Trait Implementations

impl Borrow<ObjectId> for WpDrmLeaseConnectorV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WpDrmLeaseConnectorV1

fn clone(&self) -> WpDrmLeaseConnectorV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WpDrmLeaseConnectorV1

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

Formats the value using the given formatter.

impl Hash for WpDrmLeaseConnectorV1

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<Weak<WpDrmLeaseConnectorV1>> for WpDrmLeaseConnectorV1

fn eq(&self, other: &Weak<WpDrmLeaseConnectorV1>) -> 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 PartialEq for WpDrmLeaseConnectorV1

fn eq(&self, other: &WpDrmLeaseConnectorV1) -> 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 Resource for WpDrmLeaseConnectorV1

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<WpDrmLeaseConnectorV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <WpDrmLeaseConnectorV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(WpDrmLeaseConnectorV1, <WpDrmLeaseConnectorV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <WpDrmLeaseConnectorV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for WpDrmLeaseConnectorV1