W3cubDocs

/Crystal 0.31

class Zip::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 Zip::File.

Example

require "zip"

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:

zip/reader.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

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

Creates a new reader from the given io.

def self.new(filename : String)Source

Creates a new reader from the given filename.

Class Method Detail

def self.open(io : IO, sync_close = false, &block)Source

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

def self.open(filename : String, &block)Source

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

Instance Method Detail

def closeSource

Closes this zip reader.

def closed? : BoolSource

Returns true if this reader is closed.

def each_entry(&block)Source

Yields each entry in the zip to the given block.

def next_entry : Entry?Source

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.)

def sync_close=(sync_close)Source

Whether to close the enclosed IO when closing this reader.

def sync_close? : BoolSource

Whether to close the enclosed IO when closing this reader.

© 2012–2019 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.31.1/Zip/Reader.html