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

docs: use more descriptive langauge

Browse source
This commit is contained in:
Marli Frost 2020-08-19 13:25:21 +01:00
parent 0e482afe2e
commit 33de808d0f
No known key found for this signature in database
GPG key ID: CB0BEA7CF9BD1245
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/write.rs
View file

@ -1,4 +1,4 @@
//! Structs for creating a new zip archive //! Types for creating ZIP archives
use crate::compression::CompressionMethod; use crate::compression::CompressionMethod;
use crate::result::{ZipError, ZipResult}; use crate::result::{ZipError, ZipResult};
@ -34,7 +34,10 @@ enum GenericZipWriter<W: Write + io::Seek> {
Bzip2(BzEncoder<W>), Bzip2(BzEncoder<W>),
} }
/// Generator for ZIP files. /// ZIP archive generator
///
/// Handles the bookkeeping involved in building an archive, and provides an
/// API to edit its contents.
/// ///
/// ``` /// ```
/// fn doit() -> zip::result::ZipResult<()> /// fn doit() -> zip::result::ZipResult<()>
@ -183,9 +186,9 @@ impl ZipWriterStats {
} }
impl<W: Write + io::Seek> ZipWriter<W> { impl<W: Write + io::Seek> ZipWriter<W> {
/// Initializes the ZipWriter. /// Initializes the archive.
/// ///
/// Before writing to this object, the start_file command should be called. /// Before writing to this object, the [`ZipWriter::start_file`] function should be called.
pub fn new(inner: W) -> ZipWriter<W> { pub fn new(inner: W) -> ZipWriter<W> {
ZipWriter { ZipWriter {
inner: GenericZipWriter::Storer(inner), inner: GenericZipWriter::Storer(inner),
@ -272,7 +275,9 @@ impl<W: Write + io::Seek> ZipWriter<W> {
Ok(()) Ok(())
} }
/// Starts a file. /// Create a file in the archive and start writing its' contents.
///
/// The data should be written using the [`io::Write`] implementation on this [`ZipWriter`]
pub fn start_file<S>(&mut self, name: S, mut options: FileOptions) -> ZipResult<()> pub fn start_file<S>(&mut self, name: S, mut options: FileOptions) -> ZipResult<()>
where where
S: Into<String>, S: Into<String>,