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

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

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

Creates a new reader from the given io.


[View source]
def self.new(filename : 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 : 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 #

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? #

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

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]