class Zip64::File

Overview

Provides random read access to zip file entries stores inside a File or an IO::Memory.

Example

require "zip64"

Zip64::File.open("./file.zip") do |file|
  # Iterate through all entries printing their filename and contents
  file.entries.each do |entry|
    p entry.filename
    entry.open do |io|
      p io.gets_to_end
    end
  end

  # Random access to entries by filename is also provided
  entry = file["some_file.txt"]
  entry.open do |io|
    p io.gets_to_end
  end
end

Defined in:

zip64/file.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

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

Opens a Zip64::File for reading from the given io.


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

Opens a Zip64::File for reading from the given filename.


[View source]

Class Method Detail

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

Opens a Zip64::File for reading from the given io, yields it to the given block, and closes it at the end.


[View source]
def self.open(filename : Path | String, &) #

Opens a Zip64::File for reading from the given filename, yields it to the given block, and closes it at the end.


[View source]

Instance Method Detail

def [](filename : Path | String) : Entry #

Returns the entry that has the given filename, or raises KeyError if no such entry exists.


[View source]
def []?(filename : Path | String) : Entry | Nil #

Returns the entry that has the given filename, or nil if no such entry exists.


[View source]
def close : Nil #

Closes this zip file.


[View source]
def closed? : Bool #

Returns true if this zip file is closed.


[View source]
def comment : String #

Returns the zip file comment.


[View source]
def entries : Array(Entry) #

Returns all entries inside this zip file.


[View source]