danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: added the defaults for some Options (#661)

Browse source 
There are some parts of the `Options`-struct that miss the defaults.
I also made sure that `Interlacing` is a link
This commit is contained in:
Frank Elsinga 2024-12-20 17:08:13 +01:00 committed by GitHub
parent 4df1464f39
commit 8740f475d7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/options.rs
View file

@ -97,13 +97,16 @@ pub struct Options {
pub filter: IndexSet<RowFilter>,
/// Whether to change the interlacing type of the file.
///
/// `None` will not change the current interlacing type.
///
/// `Some(x)` will change the file to interlacing mode `x`.
/// These are the interlacing types avaliable:
/// - `None` will not change the current interlacing type.
/// - `Some(x)` will change the file to interlacing mode `x`.
/// See [`Interlacing`] for the possible interlacing types.
///
/// Default: `Some(Interlacing::None)`
pub interlace: Option<Interlacing>,
/// Whether to allow transparent pixels to be altered to improve compression.
///
/// Default: `false`
pub optimize_alpha: bool,
/// Whether to attempt bit depth reduction
///
@ -145,9 +148,10 @@ pub struct Options {
///
/// Default: `true`
pub fast_evaluation: bool,
/// Maximum amount of time to spend on optimizations.
/// Further potential optimizations are skipped if the timeout is exceeded.
///
/// Default: `None`
pub timeout: Option<Duration>,
}