Struct ExtIdleNotifierV1

pub struct ExtIdleNotifierV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

idle notification manager

This interface allows clients to monitor user idle status.

After binding to this global, clients can create ext_idle_notification_v1 objects to get notified when the user is idle for a given amount of time.

This interface has no events.

Implementations

impl ExtIdleNotifierV1

pub fn destroy(&self)

destroy the manager

Destroy the manager object. All objects created via this interface remain valid.

pub fn get_idle_notification<U, D>( &self, timeout: u32, seat: &WlSeat, qh: &QueueHandle<D>, udata: U, ) -> ExtIdleNotificationV1

where U: Send + Sync + 'static, D: Dispatch<ExtIdleNotificationV1, U> + 'static,

create a notification object

Create a new idle notification object.

The notification object has a minimum timeout duration and is tied to a seat. The client will be notified if the seat is inactive for at least the provided timeout. See ext_idle_notification_v1 for more details.

A zero timeout is valid and means the client wants to be notified as soon as possible when the seat is inactive.

pub fn get_input_idle_notification<U, D>( &self, timeout: u32, seat: &WlSeat, qh: &QueueHandle<D>, udata: U, ) -> ExtIdleNotificationV1

where U: Send + Sync + 'static, D: Dispatch<ExtIdleNotificationV1, U> + 'static,

create a notification object

Create a new idle notification object to track input from the user, such as keyboard and mouse movement. Because this object is meant to track user input alone, it ignores idle inhibitors.

The notification object has a minimum timeout duration and is tied to a seat. The client will be notified if the seat is inactive for at least the provided timeout. See ext_idle_notification_v1 for more details.

A zero timeout is valid and means the client wants to be notified as soon as possible when the seat is inactive.

Trait Implementations

impl Borrow<ObjectId> for ExtIdleNotifierV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtIdleNotifierV1

fn clone(&self) -> ExtIdleNotifierV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtIdleNotifierV1

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

Formats the value using the given formatter.

impl Hash for ExtIdleNotifierV1

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

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

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

type Request<'request> = Request<'request>

The request enum for this interface

type 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: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <ExtIdleNotifierV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <ExtIdleNotifierV1 as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id( conn: &Connection, id: ObjectId, ) -> Result<ExtIdleNotifierV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ExtIdleNotifierV1

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ExtIdleNotifierV1, <ExtIdleNotifierV1 as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ExtIdleNotifierV1 as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

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

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

Creates a weak handle to this object

impl Eq for ExtIdleNotifierV1