In Files

  • rubygems/package/tar_reader.rb

Parent

Included Modules

Class/Module Index [+]

Quicksearch

Gem::Package::TarReader

TarReader reads tar files and allows iteration over their items

Public Class Methods

new(io) click to toggle source

Creates a new TarReader on io and yields it to the block, if given.

 
               # File rubygems/package/tar_reader.rb, line 21
def self.new(io)
  reader = super

  return reader unless block_given?

  begin
    yield reader
  ensure
    reader.close
  end

  nil
end
            
new(io) click to toggle source

Creates a new tar file reader on io which needs to respond to pos, eof?, read, getc and pos=

 
               # File rubygems/package/tar_reader.rb, line 39
def initialize(io)
  @io = io
  @init_pos = io.pos
end
            

Public Instance Methods

close() click to toggle source

Close the tar file

 
               # File rubygems/package/tar_reader.rb, line 47
def close
end
            
each() click to toggle source

Iterates over files in the tarball yielding each entry

 
               # File rubygems/package/tar_reader.rb, line 53
def each
  loop do
    return if @io.eof?

    header = Gem::Package::TarHeader.from @io
    return if header.empty?

    entry = Gem::Package::TarReader::Entry.new header, @io
    size = entry.header.size

    yield entry

    skip = (512 - (size % 512)) % 512
    pending = size - entry.bytes_read

    begin
      # avoid reading...
      @io.seek pending, IO::SEEK_CUR
      pending = 0
    rescue Errno::EINVAL, NameError
      while pending > 0 do
        bytes_read = @io.read([pending, 4096].min).size
        raise UnexpectedEOF if @io.eof?
        pending -= bytes_read
      end
    end

    @io.read skip # discard trailing zeros

    # make sure nobody can use #read, #getc or #rewind anymore
    entry.close
  end
end
            
Also aliased as: each_entry
each_entry() click to toggle source
Alias for: each
rewind() click to toggle source

NOTE: Do not call rewind during each

 
               # File rubygems/package/tar_reader.rb, line 92
def rewind
  if @init_pos == 0 then
    raise Gem::Package::NonSeekableIO unless @io.respond_to? :rewind
    @io.rewind
  else
    raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos=
    @io.pos = @init_pos
  end
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus