displays_physical_linux_sys 0.1.0

Rust library for querying and updating Linux backlight and LED brightness devices via sysfs
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
61
62
63
64
65
66
67
68
69
70

use std::path::PathBuf;

use thiserror::Error;

/// Errors that can occur while querying Linux brightness devices.
#[derive(Debug, Error)]
pub enum QueryError {
    /// Reading a sysfs class directory such as `/sys/class/backlight` failed.
    #[error("failed to read sysfs class directory '{path}': {source}")]
    ReadClassDirectory {
        /// The class directory that failed to be read.
        path: PathBuf,
        #[source]
        /// The underlying I/O error.
        source: std::io::Error,
    },
    /// Reading metadata for an individual sysfs device directory failed.
    #[error("failed to read device metadata from '{path}': {source}")]
    ReadDeviceDirectory {
        /// The device directory that failed to be inspected.
        path: PathBuf,
        #[source]
        /// The underlying I/O error.
        source: std::io::Error,
    },
    /// A required sysfs file such as `brightness` or `max_brightness` was missing.
    #[error("missing required sysfs file '{path}'")]
    MissingFile {
        /// The missing file path.
        path: PathBuf,
    },
    /// Reading a sysfs file failed.
    #[error("failed to read sysfs file '{path}': {source}")]
    ReadFile {
        /// The file path that failed to be read.
        path: PathBuf,
        #[source]
        /// The underlying I/O error.
        source: std::io::Error,
    },
    /// A sysfs file contained a value that could not be parsed as an integer.
    #[error("failed to parse unsigned integer from '{path}': '{content}'")]
    ParseFile {
        /// The file path that contained the invalid value.
        path: PathBuf,
        /// The invalid trimmed file contents.
        content: String,
    },
}

/// Errors that can occur while applying Linux brightness updates.
#[derive(Debug, Error)]
pub enum ApplyError {
    /// Querying current devices and state failed before the write could happen.
    #[error(transparent)]
    Query {
        #[from]
        /// The underlying query error.
        source: QueryError,
    },
    /// Writing a normalized brightness value to sysfs failed.
    #[error("failed to write brightness to '{path}': {source}")]
    WriteFile {
        /// The target `brightness` file path.
        path: PathBuf,
        #[source]
        /// The underlying I/O error.
        source: std::io::Error,
    },
}