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

docs: use more descriptive language

Browse source
This commit is contained in:
Marli Frost 2020-08-19 13:52:27 +01:00
parent e8eb019e99
commit bebecb8301
No known key found for this signature in database
GPG key ID: CB0BEA7CF9BD1245
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/read.rs
View file

@ -1,4 +1,4 @@
//! Structs for reading a ZIP archive //! Types for reading ZIP archives
use crate::compression::CompressionMethod; use crate::compression::CompressionMethod;
use crate::crc32::Crc32Reader; use crate::crc32::Crc32Reader;
@ -31,7 +31,7 @@ mod ffi {
pub const S_IFREG: u32 = 0o0100000; pub const S_IFREG: u32 = 0o0100000;
} }
/// Wrapper for reading the contents of a ZIP file. /// ZIP archive reader
/// ///
/// ```no_run /// ```no_run
/// # use std::io::prelude::*; /// # use std::io::prelude::*;
@ -276,7 +276,9 @@ impl<R: Read + io::Seek> ZipArchive<R> {
} }
} }
/// Opens a Zip archive and parses the central directory /// Read a ZIP archive, collecting the files it contains
///
/// This uses the central directory record of the ZIP file, and ignores local file headers
pub fn new(mut reader: R) -> ZipResult<ZipArchive<R>> { pub fn new(mut reader: R) -> ZipResult<ZipArchive<R>> {
let (footer, cde_start_pos) = spec::CentralDirectoryEnd::find_and_parse(&mut reader)?; let (footer, cde_start_pos) = spec::CentralDirectoryEnd::find_and_parse(&mut reader)?;