Class: Zip::InputStream

Inherits:
Object
  • Object
show all
Includes:
Zip::IOExtras::AbstractInputStream
Defined in:
lib/zip/input_stream.rb

Overview

InputStream is the basic class for reading zip entries in a zip file. It is possible to create a InputStream object directly, passing the zip file name to the constructor, but more often than not the InputStream will be obtained from a File (perhaps using the ZipFileSystem interface) object for a particular entry in the zip archive.

A InputStream inherits IOExtras::AbstractInputStream in order to provide an IO-like interface for reading from a single zip entry. Beyond methods for mimicking an IO-object it contains the method get_next_entry for iterating through the entries of an archive. get_next_entry returns a Entry object that describes the zip entry the InputStream is currently reading from.

Example that creates a zip archive with ZipOutputStream and reads it back again with a InputStream.

require 'zip'

Zip::OutputStream.open("my.zip") do |io|

  io.put_next_entry("first_entry.txt")
  io.write "Hello world!"

  io.put_next_entry("adir/first_entry.txt")
  io.write "Hello again!"
end

Zip::InputStream.open("my.zip") do |io|

  while (entry = io.get_next_entry)
    puts "Contents of #{entry.name}: '#{io.read}'"
  end
end

java.util.zip.ZipInputStream is the original inspiration for this class.

Instance Attribute Summary

Attributes included from Zip::IOExtras::AbstractInputStream

#lineno, #pos

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Zip::IOExtras::AbstractInputStream

#each_line, #flush, #gets, #read, #readline, #readlines, #ungetc

Methods included from Zip::IOExtras::FakeIO

#kind_of?

Constructor Details

#initialize(context, offset = 0, decrypter = nil) ⇒ InputStream

Opens the indicated zip file. An exception is thrown if the specified offset in the specified filename is not a local zip entry header.

Parameters:

  • context (String||IO||StringIO)

    file path or IO/StringIO object

  • offset (Integer) (defaults to: 0)

    offset in the IO/StringIO


50
51
52
53
54
55
56
# File 'lib/zip/input_stream.rb', line 50

def initialize(context, offset = 0, decrypter = nil)
  super()
  @archive_io = get_io(context, offset)
  @decompressor  = ::Zip::NullDecompressor
  @decrypter     = decrypter || ::Zip::NullDecrypter.new
  @current_entry = nil
end

Class Method Details

.open(filename_or_io, offset = 0, decrypter = nil) ⇒ Object

Same as #initialize but if a block is passed the opened stream is passed to the block and closed when the block returns.


95
96
97
98
99
100
101
102
103
# File 'lib/zip/input_stream.rb', line 95

def open(filename_or_io, offset = 0, decrypter = nil)
  zio = new(filename_or_io, offset, decrypter)
  return zio unless block_given?
  begin
    yield zio
  ensure
    zio.close if zio
  end
end

.open_buffer(filename_or_io, offset = 0) ⇒ Object


105
106
107
108
# File 'lib/zip/input_stream.rb', line 105

def open_buffer(filename_or_io, offset = 0)
  puts 'open_buffer is deprecated!!! Use open instead!'
  open(filename_or_io, offset)
end

Instance Method Details

#closeObject


58
59
60
# File 'lib/zip/input_stream.rb', line 58

def close
  @archive_io.close
end

#eofObject Also known as: eof?


85
86
87
# File 'lib/zip/input_stream.rb', line 85

def eof
  @output_buffer.empty? && @decompressor.eof
end

#get_next_entryObject

Returns a Entry object. It is necessary to call this method on a newly created InputStream before reading from the first entry in the archive. Returns nil when there are no more entries.


66
67
68
69
# File 'lib/zip/input_stream.rb', line 66

def get_next_entry
  @archive_io.seek(@current_entry.next_header_offset, IO::SEEK_SET) if @current_entry
  open_entry
end

#rewindObject

Rewinds the stream to the beginning of the current entry


72
73
74
75
76
77
78
# File 'lib/zip/input_stream.rb', line 72

def rewind
  return if @current_entry.nil?
  @lineno = 0
  @pos    = 0
  @archive_io.seek(@current_entry.local_header_offset, IO::SEEK_SET)
  open_entry
end

#sysread(number_of_bytes = nil, buf = nil) ⇒ Object

Modeled after IO.sysread


81
82
83
# File 'lib/zip/input_stream.rb', line 81

def sysread(number_of_bytes = nil, buf = nil)
  @decompressor.sysread(number_of_bytes, buf)
end