Skip to content

class Compress::Zip::Reader
inherits Reference

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

require "compress/zip"

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

Class methods

.open(io : IO, sync_close = false

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

View source

.open(filename : String

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

View source

.new(io : IO, sync_close = false)

Creates a new reader from the given io.

View source

.new(filename : String)

Creates a new reader from the given filename.

View source

Methods

#close

Closes this zip reader.

View source

#closed? : Bool

Returns true if this reader is closed.

View source

#each_entry

Yields each entry in the zip to the given block.

View source

#next_entry : Entry?

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

After reading a next entry, previous entries can no longer be read (their IO will be closed.)

View source

#sync_close=(sync_close)

Whether to close the enclosed IO when closing this reader.

View source

#sync_close? : Bool

Whether to close the enclosed IO when closing this reader.

View source