Struct zip::write::ZipWriter

pub struct ZipWriter<W: Write + Seek> { /* fields omitted */ }

Generator for ZIP files.

fn doit() -> zip::result::ZipResult<()>
{
    use std::io::Write;

    // For this example we write to a buffer, but normally you should use a File
    let mut buf: &mut [u8] = &mut [0u8; 65536];
    let mut w = std::io::Cursor::new(buf);
    let mut zip = zip::ZipWriter::new(w);

    let options = zip::write::FileOptions::default().compression_method(zip::CompressionMethod::Stored);
    zip.start_file("hello_world.txt", options)?;
    zip.write(b"Hello, World!")?;

    // Optionally finish the zip. (this is also done on drop)
    zip.finish()?;

    Ok(())
}

println!("Result: {:?}", doit().unwrap());

Methods

impl<W: Write + Seek> ZipWriter<W>

pub fn new(inner: W) -> ZipWriter<W>

Initializes the ZipWriter.

Before writing to this object, the start_file command should be called.

pub fn set_comment<S>(&mut self, comment: S) where
    S: Into<String>, 

Set ZIP archive comment. Defaults to 'zip-rs' if not set.

pub fn start_file<S>(&mut self, name: S, options: FileOptions) -> ZipResult<()> where
    S: Into<String>, 

Starts a file.

pub fn start_file_from_path(
    &mut self,
    path: &Path,
    options: FileOptions
) -> ZipResult<()>

Starts a file, taking a Path as argument.

This function ensures that the '/' path seperator is used. It also ignores all non 'Normal' Components, such as a starting '/' or '..' and '.'.

pub fn add_directory<S>(
    &mut self,
    name: S,
    options: FileOptions
) -> ZipResult<()> where
    S: Into<String>, 

Add a directory entry.

You can't write data to the file afterwards.

pub fn add_directory_from_path(
    &mut self,
    path: &Path,
    options: FileOptions
) -> ZipResult<()>

Add a directory entry, taking a Path as argument.

This function ensures that the '/' path seperator is used. It also ignores all non 'Normal' Components, such as a starting '/' or '..' and '.'.

pub fn finish(&mut self) -> ZipResult<W>

Finish the last file and write all other zip-structures

This will return the writer, but one should normally not append any data to the end of the file. Note that the zipfile will also be finished on drop.

Trait Implementations

impl<W: Write + Seek> Drop for ZipWriter<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write + Seek> Write for ZipWriter<W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.