Struct ScreenWakeLock 

pub struct ScreenWakeLock { /* private fields */ }

Guard that keeps the display from idling/sleeping while alive.

Implementations

impl ScreenWakeLock

pub fn acquire(reason: impl Into<String>) -> Result<Self, Error>

Acquire a screen wake lock with a reason string.

Examples found in repository

examples/keep_awake.rs (line 18)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let reason = args
        .next()
        .unwrap_or_else(|| "Running screen-wake-lock example".to_string());

    let seconds: u64 = args.next().as_deref().unwrap_or("10").parse().unwrap_or(10);

    if !ScreenWakeLock::is_supported() {
        eprintln!("Wake lock is not supported in this environment.");
        std::process::exit(2);
    }

    let _lock = ScreenWakeLock::acquire(&reason)?;

    println!("Keeping the display awake for {seconds}s: {reason}");
    std::thread::sleep(Duration::from_secs(seconds));
    println!("Done (wake lock released when dropped).");

    Ok(())
}

pub fn acquire_with_linux_options( reason: impl Into<String>, linux: LinuxOptions, ) -> Result<Self, Error>

Acquire, with extra Linux-specific options (safe to call on all platforms).

pub fn is_supported() -> bool

Best-effort check (Linux: checks for a usable inhibitor service).

Examples found in repository

examples/keep_awake.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut args = std::env::args().skip(1);

    let reason = args
        .next()
        .unwrap_or_else(|| "Running screen-wake-lock example".to_string());

    let seconds: u64 = args.next().as_deref().unwrap_or("10").parse().unwrap_or(10);

    if !ScreenWakeLock::is_supported() {
        eprintln!("Wake lock is not supported in this environment.");
        std::process::exit(2);
    }

    let _lock = ScreenWakeLock::acquire(&reason)?;

    println!("Keeping the display awake for {seconds}s: {reason}");
    std::thread::sleep(Duration::from_secs(seconds));
    println!("Done (wake lock released when dropped).");

    Ok(())
}

pub fn release(self)

Explicitly release early (also happens automatically on Drop).

Trait Implementations

impl Drop for ScreenWakeLock

fn drop(&mut self)

Executes the destructor for this type.