Class: Gem::Package::TarReader::Entry (Ruby 2.3.4)

Home Classes Methods

In Files

rubygems/package/tar_reader/entry.rb

Parent

Object

Methods

::new
#bytes_read
#close
#closed?
#directory?
#eof?
#file?
#full_name
#getc
#pos
#read
#readpartial
#rewind
#symlink?

Class/Module Index

Gem::Package::TarReader::Entry

Class for reading entries out of a tar file

Attributes

header[R]

Header for this tar entry

Public Class Methods

new(header, io)

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

 
               # File rubygems/package/tar_reader/entry.rb, line 20
def initialize(header, io)
  @closed = false
  @header = header
  @io = io
  @orig_pos = @io.pos
  @read = 0
end

Public Instance Methods

bytes_read()

Number of bytes read out of the tar entry

 
               # File rubygems/package/tar_reader/entry.rb, line 35
def bytes_read
  @read
end

close()

Closes the tar entry

 
               # File rubygems/package/tar_reader/entry.rb, line 42
def close
  @closed = true
end

closed?()

Is the tar entry closed?

 
               # File rubygems/package/tar_reader/entry.rb, line 49
def closed?
  @closed
end

directory?()

Is this tar entry a directory?

 
               # File rubygems/package/tar_reader/entry.rb, line 94
def directory?
  @header.typeflag == "5"
end

eof?()

Are we at the end of the tar entry?

 
               # File rubygems/package/tar_reader/entry.rb, line 56
def eof?
  check_closed

  @read >= @header.size
end

file?()

Is this tar entry a file?

 
               # File rubygems/package/tar_reader/entry.rb, line 101
def file?
  @header.typeflag == "0"
end

full_name()

Full name of the tar entry

 
               # File rubygems/package/tar_reader/entry.rb, line 65
def full_name
  if @header.prefix != "" then
    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

 
               # File rubygems/package/tar_reader/entry.rb, line 80
def getc
  check_closed

  return nil if @read >= @header.size

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

  ret
end

pos()

The position in the tar entry

 
               # File rubygems/package/tar_reader/entry.rb, line 115
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

 
               # File rubygems/package/tar_reader/entry.rb, line 125
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

Also aliased as: readpartial

readpartial(len = nil)

Alias for: read

rewind()

Rewinds to the beginning of the tar file entry

 
               # File rubygems/package/tar_reader/entry.rb, line 144
def rewind
  check_closed

  raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos=

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

symlink?()

Is this tar entry a symlink?

 
               # File rubygems/package/tar_reader/entry.rb, line 108
def symlink?
  @header.typeflag == "2"
end