nosleep-types 0.3.1

Block power save mode cross platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

use snafu::Snafu;

#[derive(Debug, Snafu)]
pub enum NoSleepError {
    #[snafu(display("Could not initialize: {:?}", reason))]
    Init { reason: String },
    #[snafu(display("Could not prevent sleep: {:?}", reason))]
    PreventSleep { reason: String },
    #[snafu(display("DBus error: {:?}", reason))]
    DBus { reason: String },
    #[snafu(display("Could not stop lock: {:?}", reason))]
    StopLock { reason: String },
}

pub trait NoSleepTrait {
    fn new() -> Result<Self, NoSleepError>
    where
        Self: Sized;

    /// Prevents the display from dimming automatically.
    /// For example: playing a video.
    fn prevent_display_sleep(&mut self) -> Result<(), NoSleepError>;

    /// Prevents the system from sleeping automatically due to a lack of user activity.
    /// For example: downloading a file in the background.
    fn prevent_system_sleep(&mut self) -> Result<(), NoSleepError>;

    /// Cancels any previous call to `prevent_display_sleep` or `prevent_system_sleep`.
    fn stop(&mut self) -> Result<(), NoSleepError>;
}