@spec entry(String.t(), Enumerable.t(), Keyword.t()) :: entry()

Creates a ZIP file entry with the given name.

The enum could be either lazy Stream or List. The elements in enum should be of type iodata

Options

• :coder (module | {module, list}) - The compressor that should be used to encode the data. Available options are:

  • Zstream.Coder.Deflate - use deflate compression

  • Zstream.Coder.Stored - store without any compression

  • Defaults to Zstream.Coder.Deflate

• :encryption_coder ({module, keyword}) - The encryption module that should be used to encrypt the data. Available options are:

  • Zstream.EncryptionCoder.Traditional - use tranditional zip encryption scheme. :password key should be present in the options. Example {Zstream.EncryptionCoder.Traditional, password: "secret"}

  • Zstream.EncryptionCoder.None - no encryption

  • Defaults to Zstream.EncryptionCoder.None

• :mtime (DateTime) - File last modication time. Defaults to system local time.

Unzips file stream.

Returns a new stream which emits the following tuples for each zip entry.

{:entry, Zstream.Entry.t/0} - Indicates a new file entry.

{:data, iodata/0 | :eof} - one or more data tuples will be emitted for each entry. :eof indicates end of data tuples for current entry.

NOTES

Unzip doesn't support all valid zip files. Zip file format allows the writer to write the file size info after the file data, which allows the writer to zip streams with unknown size. But this prevents the reader from unzipping the file in a streaming fashion, because to find the file size one has to go to the end of the stream. Ironically, if you use Zstream to zip a file, the same file can't be unzipped using Zstream.

• Doesn't support file which uses data descriptor header.
• Doesn't support encrypted file.

@spec zip(Enumerable.t(), Keyword.t()) :: Enumerable.t()

Creates a ZIP file stream.

Entries are consumed one by one in the given order.

Options

• :zip64 (boolean) - If set to true zip64 format is used. Zip64 can support files more than 4 GB in size, but not all the unzip programs support this format. Defaults to false.