Enum wayland_protocols::ext::session_lock::v1::server::ext_session_lock_v1::Event

#[non_exhaustive]
pub enum Event {
    Locked,
    Finished,
}

Available on crate features staging and server only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Locked

session successfully locked

This client is now responsible for displaying graphics while the session is locked and deciding when to unlock the session.

Either this event or the finished event will be sent immediately on creation of this object.

If this event is sent, making the destroy request is a protocol error, the lock object may only be destroyed using the unlock_and_destroy request.

Finished

the session lock object should be destroyed

The compositor has decided that the session lock should be destroyed. Exactly when this event is sent is compositor policy, but it will never be sent more than once for a given session lock object.

This might be sent because there is already another ext_session_lock_v1 object held by a client, or the compositor has decided to deny the request to lock the session for some other reason. This might also be sent because the compositor implements some alternative, secure way to authenticate and unlock the session.

Either this event or the locked event will be sent exactly once on creation of this object. If the locked event is sent on creation of this object, the finished event may still be sent at some later time in this object’s lifetime, this is compositor policy.

Upon receiving this event, the client should make either the destroy request or the unlock_and_destroy request, depending on whether or not the locked event was received on this object.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.