class Zip64::Reader

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 Zip64::File.

Example

require "zip64"

Zip64::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

Defined in:

zip64/reader.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(io : IO, sync_close : Bool = false) #

Creates a new reader from the given io.


[View source]
def self.new(filename : Path | String) #

Creates a new reader from the given filename.


[View source]

Class Method Detail

def self.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]
def self.open(filename : Path | String, &) #

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


[View source]

Instance Method Detail

def close : Nil #

Closes this zip reader.


[View source]
def closed? : Bool #

Returns true if this reader is closed.


[View source]
def each_entry(&) #

Yields each entry in the zip to the given block.


[View source]
def next_entry : Entry | Nil #

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]
def sync_close=(sync_close : Bool) #

Whether to close the enclosed IO when closing this reader.


[View source]
def sync_close? : Bool #

Whether to close the enclosed IO when closing this reader.


[View source]