Struct Lock 

pub struct Lock { /* private fields */ }

A SessionLock as the platform holds it: whether the config wants the session locked, what the compositor says, and each output’s lock surface. Dropping it disposes its owner, which frees everything it made.

Implementations

impl Lock

pub fn new(cx: &Cx, lock: SessionLock) -> Lock

Builds lock under a new child owner of cx. A locked binding is an effect, so it first runs at the next flush.

Panics

If cx’s owner was disposed, as Cx::signal does.

pub fn wanted(&self) -> Option<bool>

Whether locked says to lock; None once the lock’s owner is gone.

pub fn locked(&self) -> ReadSignal<bool>

true while the compositor says the session is locked.

pub fn set_locked(&self, locked: bool)

Records what the compositor said; a value it holds already is left alone, so nothing reruns.

pub fn surface(&self, output: &Output) -> Option<Window>

Builds output’s lock surface under a new child owner, its path SessionLock[DP-1]. A surface builder that panics is logged with that path, and the surface shows only the lock’s style. None once the lock’s owner is gone.

Trait Implementations

impl Drop for Lock

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.