Struct ExtIdleNotificationV1

pub struct ExtIdleNotificationV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

idle notification

This interface is used by the compositor to send idle notification events to clients.

Initially the notification object is not idle. The notification object becomes idle when no user activity has happened for at least the timeout duration, starting from the creation of the notification object. User activity may include input events or a presence sensor, but is compositor-specific.

How this notification responds to idle inhibitors depends on how it was constructed. If constructed from the get_idle_notification request, then if an idle inhibitor is active (e.g. another client has created a zwp_idle_inhibitor_v1 on a visible surface), the compositor must not make the notification object idle. However, if constructed from the get_input_idle_notification request, then idle inhibitors are ignored, and only input from the user, e.g. from a keyboard or mouse, counts as activity.

When the notification object becomes idle, an idled event is sent. When user activity starts again, the notification object stops being idle, a resumed event is sent and the timeout is restarted.

See also the Request enum for this interface.

Implementations

impl ExtIdleNotificationV1

pub fn idled(&self)

notification object is idle

This event is sent when the notification object becomes idle.

It’s a compositor protocol error to send this event twice without a resumed event in-between.

pub fn resumed(&self)

notification object is no longer idle

This event is sent when the notification object stops being idle.

It’s a compositor protocol error to send this event twice without an idled event in-between. It’s a compositor protocol error to send this event prior to any idled event.

Trait Implementations

impl Borrow<ObjectId> for ExtIdleNotificationV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtIdleNotificationV1

fn clone(&self) -> ExtIdleNotificationV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtIdleNotificationV1

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

Formats the value using the given formatter.

impl Hash for ExtIdleNotificationV1

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<ExtIdleNotificationV1>> for ExtIdleNotificationV1

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

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

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<ExtIdleNotificationV1, InvalidId>

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ExtIdleNotificationV1 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 ExtIdleNotificationV1