123456789_123456789_123456789_123456789_123456789_

Class: Gem::Package::TarReader::Entry

Relationships & Source Files
Inherits: Object
Defined in: lib/rubygems/package/tar_reader/entry.rb

Overview

Class for reading entries out of a tar file

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(header, io) ⇒ Entry

Creates a new tar entry for #header that will be read from io

[ GitHub ] 

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 19



def initialize(header, io)
  @closed = false
  @header = header
  @io = io
  @orig_pos = @io.pos
  @read = 0
end


  







Instance Attribute Details



  

    #closed?  ⇒ Boolean  (readonly)
  



  

    

Is the tar entry closed?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 48



def closed?
  @closed
end


  








  

    #directory?  ⇒ Boolean  (readonly)
  



  

    

Is this tar entry a directory?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 93



def directory?
  @header.typeflag == "5"
end


  








  

    #eof?  ⇒ Boolean  (readonly)
  



  

    

Are we at the end of the tar entry?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 55



def eof?
  check_closed

  @read >= @header.size
end


  








  

    #file?  ⇒ Boolean  (readonly)
  



  

    

Is this tar entry a file?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 100



def file?
  @header.typeflag == "0"
end


  








  

    #header   (readonly)
  



  

    

Header for this tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 14



attr_reader :header


  








  

    #symlink?  ⇒ Boolean  (readonly)
  



  

    

Is this tar entry a symlink?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 107



def symlink?
  @header.typeflag == "2"
end


  







Instance Method Details



  

    #bytes_read  
  



  

    

Number of bytes read out of the tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 34



def bytes_read
  @read
end


  








  

    #check_closed  
  

  

    This method is for internal use only.
  



  

    
  





  
Raises:


    
  
  • 
    (IOError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 27



def check_closed # :nodoc:
  raise IOError, "closed #{self.class}" if closed?
end


  








  

    #close  
  



  

    

Closes the tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 41



def close
  @closed = true
end


  








  

    #full_name  
  



  

    

Full name of the tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 64



def full_name
  if @header.prefix != ""
    File.join @header.prefix, @header.name
  else
    @header.name
  end
rescue ArgumentError => e
  raise unless e.message == 'string contains null byte'
  raise Gem::Package::TarInvalidError,
        'tar is corrupt, name contains null byte'
end


  








  

    #getc  
  



  

    

Read one byte from the tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 79



def getc
  check_closed

  return nil if @read >= @header.size

  ret = @io.getc
  @read += 1 if ret

  ret
end


  








  

    #length  
  



  

    

Alias for #size.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 124



alias length size


  








  

    #pos  
  



  

    

The position in the tar entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 114



def pos
  check_closed

  bytes_read
end


  








  

    #read(len = nil)  
  



  

    

Reads len bytes from the tar file entry, or the rest of the entry if nil


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 130



def read(len = nil)
  check_closed

  return nil if @read >= @header.size

  len ||= @header.size - @read
  max_read = [len, @header.size - @read].min

  ret = @io.read max_read
  @read += ret.size

  ret
end


  








  

    #readpartial(maxlen = nil, outbuf = "".b)  
  



  

    
  





  
Raises:


    
  
  • 
    (EOFError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 144



def readpartial(maxlen = nil, outbuf = "".b)
  check_closed

  raise EOFError if @read >= @header.size

  maxlen ||= @header.size - @read
  max_read = [maxlen, @header.size - @read].min

  @io.readpartial(max_read, outbuf)
  @read += outbuf.size

  outbuf
end


  








  

    #rewind  
  



  

    

Rewinds to the beginning of the tar file entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 161



def rewind
  check_closed

  @io.pos = @orig_pos
  @read = 0
end


  








  

    #size  
    Also known as: #length
  

  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader/entry.rb', line 120



def size
  @header.size
end