blight 0.8.0

A hassle-free CLI backlight utility/library for Linux.
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# Version 0.8.0

### Added
- library support for LED interface (`/sys/class/leds`) 🎉
- LED support in CLI 🎉
- Updated `blight setup` script with additional udev rules to allow user to modify LED brightness files
  - *RECOMMENDED*: run `sudo blight setup` again after updating to the latest version, for LED functionality to work.
- `toggle` method to toggle between min and max supported brightness values
  - Mainly intended to be used for LEDs, but is also available on the `Device` type
- `Device::new_locked` method to init a backlight device with an exclusive lock on the brightness file
  - A method of the same name also exists for the `Led` type

### Improved
- Better and cleaner implementation of the code that reads brightness values from ASCII text
- Improved code examples in the inline documentation
- All doc tests are set to `no_run` instead of `ignore`, to ensure all doc examples compile
- All successful write operations update the `current` brightness value in `self`
  - This makes calling `reload` after a write optional and is required only if brightness values were modified by an external process
- CLI deps are now behind a feature gate (enabled by default)
  - library users are now recommended to use `cargo add --no-default-features`

### Changed
- [BREAKING!] `sweep_write` returns `ErrorKind::ValueTooLarge` if the provided value is larger than `max` (same as `write_value`) instead of silently ignoring it
- [BREAKING!] `Device` is now required to be mutable to call any methods that change the brightness value, since the struct now internally holds the opened brightness file.
- [BREAKING!] `Error` type which was previously an enum, is now a struct.
  - To distinguish between different error types, use `Error::kind` to access the `ErrorKind` enum.
  - To acess the source of the error, use `Error::source` 
- [BREAKING!] Core functionality provided on the `Device` type is now made available through the `Light` trait, which is also shared with `Led`
- [BREAKING!] `device_path` method now returns a `&Path` instead of a `PathBuf`
- `blight::Result` is now the preferred type alias for the result type, not `blight::BlResult`
 - The old type alias is still included
- [BREAKING!] Migrated from `fs4` to std lib based file locking (feature gated under `locking`)
  - Read the below `MSRV` section for details

### Note on MSRV
The minimum supported Rust version depends on how you use this crate.
- Binary with `cli` feature (required) enabled: MSRV = `1.95.0` 
  - `cargo msrv find` or `cargo msrv find -- cargo check --bin blight`
- Library with `locking` feature enabled: MSRV = `1.89.0`
  - `cargo msrv find -- cargo check --lib --no-default features --features locking`
- Library with all features disabled: MSRV = `1.82.0`
  - `cargo msrv find -- cargo check --lib --no-default features`

# Version 0.7.1

### Summary
A minor bug fix release that changes the behavior of how errors are handled while acquiring a lock.
Note: This release only contains changes to the CLI.

### Fixed
- Handle errors while acquiring a lock instead of panicking (#9)

# Version 0.7.0

### Summary
This release contains some breaking changes for the library users, like the type change from `u16 `to `u32` as part of a bug fix. Other than that, a `current_percent` method has been added to `Device` for convenience, and there's a minor CLI related change. The rest of the changes are all memory usage improvements and code refactoring for improved maintainability.

### Added
- `Device::current_percent` method that returns brightness percentage (in contrast with `current` which returns the raw current value)

### Changed
- All functions and methods that took and returned `u16` now use `u32` (breaking change)
- `device_path` method now returns a `PathBuf `instead of `&Path` due to internal code changes (breaking change)
- `blight status` now prints brightness percentage along with the raw value

### Improved
- Significant reduction of heap allocations
- Reduced code duplication and code refactored for maintainability

### Fixed
- blight failing to work with devices that may use values larger than `u16::MAX` - #6 (Thanks pdamianik)

# Version 0.6.0

### Summary
Fixed a major bug related to single instance check, which also changes the CLI behavior slightly. Improved error reporting in case of panics. Most changes in this release only affect the CLI side of things.

### Changed
- CLI no longer returns an error if another instance is running. Instead, it waits for it to finish (#5)
- blight no longer compiles on OSs other than Linux, as they are unsupported

### Improved
- Custom panic handler now properly prints panic related info to the user to help with better bug reports

### Fixed
- CLI falsely reporting that another instance is running (#4)

# Version 0.5.0

### Added
- `Device::device_path` method, returns `&Path` to the location of the device in `sys/class/backlight/`
- `Delay` type to customize the write frequency or delay between each write in `Device::sweep_write`
- Custom panic hook (CLI) to print more helpful messages when a panic occurs

### Improved
- `Device::reload` only reloads current value
- `Device::sweep_write` updates brightness changes more efficiently (#2)

### Changed
- Helper function `sweep` is now `Device::sweep_write` (#2)

### Fixed
- Integer overflow while using sweep change (#1)
- `Device::write_value` & `set_bl` silently ignoring or writing values larger than max supported (f30b3c5)
- Stdout and Stderr message formatting inconsistencies