DevComp/zip-rs-wasm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update doc comment about compression_method

Browse source
This commit is contained in:
Chris Hennick 2023-06-01 12:56:11 -07:00
parent 60553541ed
commit 7b23b3212a
No known key found for this signature in database
GPG key ID: 25653935CC8B6C74
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/write.rs
View file

@ -231,8 +231,10 @@ impl arbitrary::Arbitrary<'_> for FileOptions {
impl FileOptions {
/// Set the compression method for the new file
///
/// The default is `CompressionMethod::Deflated`. If the deflate compression feature is
/// disabled, `CompressionMethod::Stored` becomes the default.
/// The default is `CompressionMethod::Deflated` if it is enabled. If not,
/// `CompressionMethod::Bzip2` is the default if it is enabled. If neither `bzip2` nor `deflate`
/// is enabled, `CompressionMethod::Zlib` is the default. If all else fails,
/// `CompressionMethod::Stored` becomes the default and files are written uncompressed.
#[must_use]
pub fn compression_method(mut self, method: CompressionMethod) -> FileOptions {
self.compression_method = method;