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

docs: elaborate on usage of CompressionMethod

Browse source
This commit is contained in:
Marli Frost 2020-08-19 12:20:43 +01:00
parent 62dc40678e
commit f508aac0cd
No known key found for this signature in database
GPG key ID: CB0BEA7CF9BD1245
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/compression.rs
View file

@ -3,19 +3,25 @@
use std::fmt;
#[allow(deprecated)]
/// Compression methods for the contents of a ZIP file.
/// Identifies the storage format used to compress a file within a ZIP archive.
///
/// Each file's compression method is stored alongside it, allowing the
/// contents to be read without context.
///
/// When creating ZIP files, you may choose the method to use with
/// [`zip::write::FileOptions::compression_method`]
#[derive(Copy, Clone, PartialEq, Debug)]
pub enum CompressionMethod {
/// The file is stored (no compression)
/// Store the file as is
Stored,
/// Deflate using any flate2 backend
/// Compress the file using Deflate
#[cfg(any(
feature = "deflate",
feature = "deflate-miniz",
feature = "deflate-zlib"
))]
Deflated,
/// File is compressed using BZIP2 algorithm
/// Compress the file using BZIP2
#[cfg(feature = "bzip2")]
Bzip2,
/// Unsupported compression method