brightness 0.8.0

Get and set display brightness
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// Copyright (C) 2022 The brightness project authors. Distributed under the 0BSD license.

//! The blocking API.

use crate::Error;

cfg_if::cfg_if! {
    if #[cfg(target_os = "linux")] {
        pub(crate) mod linux;
        use self::linux as platform;
    } else if #[cfg(windows)] {
        pub mod windows;
        use self::windows as platform;
    } else {
        compile_error!("unsupported platform");
    }
}

/// Blocking brightness device.
#[derive(Debug)]
pub struct BrightnessDevice(platform::BlockingDeviceImpl);

/// Blocking interface to get and set brightness.
pub trait Brightness {
    /// Returns the device name.
    fn device_name(&self) -> Result<String, Error>;

    /// Returns a human-readable device name suitable for display to users.
    /// This may differ from the technical device identifier returned by `device_name()`.
    fn friendly_device_name(&self) -> Result<String, Error>;

    /// Returns the current brightness as a percentage.
    fn get(&self) -> Result<u32, Error>;

    /// Sets the brightness as a percentage.
    fn set(&self, percentage: u32) -> Result<(), Error>;
}

impl Brightness for BrightnessDevice {
    fn device_name(&self) -> Result<String, Error> {
        self.0.device_name()
    }

    fn friendly_device_name(&self) -> Result<String, Error> {
        self.0.friendly_device_name()
    }

    fn get(&self) -> Result<u32, Error> {
        self.0.get()
    }

    fn set(&self, percentage: u32) -> Result<(), Error> {
        self.0.set(percentage)
    }
}

/// Blocking function that returns all brightness devices on the running system.
pub fn brightness_devices() -> impl Iterator<Item = Result<BrightnessDevice, Error>> {
    platform::brightness_devices().map(|r| r.map(BrightnessDevice).map_err(Into::into))
}