class Compress::Zip::Writer

• Compress::Zip::Writer
• Reference
• Object

Overview

Writes (streams) zip entries to an IO.

Example

require "compress/zip"

File.open("./file.zip", "w") do |file|
  Compress::Zip::Writer.open(file) do |zip|
    # Add a file with a String content
    zip.add "foo.txt", "contents of foo"

    # Add a file and write data to it through an IO
    zip.add("bar.txt") do |io|
      io << "contents of bar"
    end

    # Add a file by referencing a file in the filesystem
    # (the file is automatically closed after this call)
    zip.add("baz.txt", File.open("./some_file.txt"))
  end
end

Defined in:

Constructors

• .new(io : IO, sync_close : Bool = false)

  Creates a new writer to the given io.

• .new(filename : Path | String)

  Creates a new writer to the given filename.

Class Method Summary

• .open(io : IO, sync_close = false, &)

  Creates a new writer to the given io, yields it to the given block, and closes it at the end.

• .open(filename : Path | String, &)

  Creates a new writer to the given filename, yields it to the given block, and closes it at the end.

Instance Method Summary

• #add(filename : Path | String, &)

  Adds an entry that will have the given filename and current time (Time.utc) and yields an IO to write that entry's contents.

• #add(entry : Entry, &)

  Adds an entry and yields IO to write that entry's contents.

• #add(filename_or_entry : Path | String | Entry, string : String) : Nil

  Adds an entry that will have string as its contents.

• #add(filename_or_entry : Path | String | Entry, bytes : Bytes) : Nil

  Adds an entry that will have bytes as its contents.

• #add(filename_or_entry : Path | String | Entry, data : IO) : Nil

  Adds an entry that will have its data copied from the given data.

• #add_dir(name) : Nil

  Adds a directory entry that will have the given name.

• #close : Nil

  Closes this zip writer.

• #closed? : Bool

  Returns true if this writer is closed.

• #comment=(comment : String)

  Sets the zip file comment

• #sync_close=(sync_close : Bool)

  Whether to close the enclosed IO when closing this writer.

• #sync_close? : Bool

  Whether to close the enclosed IO when closing this writer.

Constructor Detail

Class Method Detail

Instance Method Detail