Struct WakeLock 

#[non_exhaustive]
pub struct WakeLock;

Available on crate feature unstable only.

A guard that prevents the system from entering automatic light sleep.

While at least one WakeLock is held, WakeLock::is_active returns true and the auto-lightsleep idle hook will not put the chip to sleep. The lock is released when the guard is dropped.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations

impl WakeLock

pub fn new() -> Self

Acquires a wake lock, preventing automatic light sleep until it is dropped.

pub fn acquire()

Acquires a wake lock, preventing automatic light sleep.

pub fn release()

Releases a wake lock, allowing automatic light sleep when no wake locks are held.

Note that this function should only be called to release a wake lock acquired via Self::acquire.

pub fn is_active() -> bool

Returns true if at least one wake lock is currently held.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl Clone for WakeLock

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WakeLock

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn default() -> Self

Returns the “default value” for a type.

impl Drop for WakeLock

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.