Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix compression level range from 0-9 to 0-10 #427

Merged
merged 1 commit into from
Sep 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,10 @@ impl Compression {
///
/// The integer here is typically on a scale of 0-9 where 0 means "no
/// compression" and 9 means "take as long as you'd like".
///
/// It is worth noting that `flate2` supports both `zlib` and `miniz`
/// backends for compression, where `miniz` also provides a level `10` of
/// compression.
pub const fn new(level: u32) -> Compression {
Compression(level)
}
Expand All @@ -213,7 +217,7 @@ impl Compression {
}

/// Returns an integer representing the compression level, typically on a
/// scale of 0-9
/// scale of 0-9. With `miniz` backend, level 10 is also possible.
pub fn level(&self) -> u32 {
self.0
}
Expand Down