class Zip::Reader

• Zip::Reader
• Reference
• Object

Overview

Reads zip file entries sequentially from an IO.

NOTE Entries might not have correct values for crc32, compressed_size, uncompressed_size and comment, because when reading a zip file directly from a stream this information might be stored later in the zip stream. If you need this information, consider using Zip::File.

Example

File.open("./file.zip") do |file|
  Zip::Reader.open(file) do |zip|
    zip.each_entry do |entry|
      p entry.filename
      p entry.file?
      p entry.dir?
      p entry.io.gets_to_end
    end
  end
end

Defined in:

Constructors

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

  Creates a new reader from the given io.

• .new(filename : String)

  Creates a new reader from the given filename.

Class Method Summary

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

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

• .open(filename : String, &block)

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

Instance Method Summary

• #close

  Closes this zip reader.

• #closed? : Bool

  Returns true if this reader is closed.

• #each_entry(&block)

  Yields each entry in the zip to the given block.

• #next_entry : Entry?

  Reads the next entry in the zip, or nil if there are no more entries.

• #sync_close=(sync_close)

  Whether to close the enclosed IO when closing this reader.

• #sync_close? : Bool

  Whether to close the enclosed IO when closing this reader.

Constructor Detail

Class Method Detail

Instance Method Detail