Class: Gem::Package::TarReader::Entry
- Inherits:
-
Object
- Object
- Gem::Package::TarReader::Entry
- Defined in:
- lib/rubygems/package/tar_reader/entry.rb
Overview
Class for reading entries out of a tar file
Instance Attribute Summary collapse
-
#header ⇒ Object
readonly
Header for this tar entry.
Instance Method Summary collapse
-
#bytes_read ⇒ Object
Number of bytes read out of the tar entry.
-
#check_closed ⇒ Object
:nodoc:.
-
#close ⇒ Object
Closes the tar entry.
-
#closed? ⇒ Boolean
Is the tar entry closed?.
-
#directory? ⇒ Boolean
Is this tar entry a directory?.
-
#eof? ⇒ Boolean
Are we at the end of the tar entry?.
-
#file? ⇒ Boolean
Is this tar entry a file?.
-
#full_name ⇒ Object
Full name of the tar entry.
-
#getc ⇒ Object
Read one byte from the tar entry.
-
#initialize(header, io) ⇒ Entry
constructor
Creates a new tar entry for
header
that will be read fromio
. -
#pos ⇒ Object
The position in the tar entry.
-
#read(len = nil) ⇒ Object
Reads
len
bytes from the tar file entry, or the rest of the entry if nil. -
#rewind ⇒ Object
Rewinds to the beginning of the tar file entry.
Constructor Details
#initialize(header, io) ⇒ Entry
Creates a new tar entry for header
that will be read from io
20 21 22 23 24 25 26 |
# File 'lib/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 |
Instance Attribute Details
#header ⇒ Object (readonly)
Header for this tar entry
15 16 17 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 15 def header @header end |
Instance Method Details
#bytes_read ⇒ Object
Number of bytes read out of the tar entry
35 36 37 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 35 def bytes_read @read end |
#check_closed ⇒ Object
:nodoc:
28 29 30 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 28 def check_closed # :nodoc: raise IOError, "closed #{self.class}" if closed? end |
#close ⇒ Object
Closes the tar entry
42 43 44 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 42 def close @closed = true end |
#closed? ⇒ Boolean
Is the tar entry closed?
49 50 51 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 49 def closed? @closed end |
#directory? ⇒ Boolean
Is this tar entry a directory?
94 95 96 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 94 def directory? @header.typeflag == "5" end |
#eof? ⇒ Boolean
Are we at the end of the tar entry?
56 57 58 59 60 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 56 def eof? check_closed @read >= @header.size end |
#file? ⇒ Boolean
Is this tar entry a file?
101 102 103 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 101 def file? @header.typeflag == "0" end |
#full_name ⇒ Object
Full name of the tar entry
65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/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. == 'string contains null byte' raise Gem::Package::TarInvalidError, 'tar is corrupt, name contains null byte' end |
#getc ⇒ Object
Read one byte from the tar entry
80 81 82 83 84 85 86 87 88 89 |
# File 'lib/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 ⇒ Object
The position in the tar entry
108 109 110 111 112 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 108 def pos check_closed bytes_read end |
#read(len = nil) ⇒ Object
Reads len
bytes from the tar file entry, or the rest of the entry if nil
118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 118 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 |
#rewind ⇒ Object
Rewinds to the beginning of the tar file entry
135 136 137 138 139 140 141 142 |
# File 'lib/rubygems/package/tar_reader/entry.rb', line 135 def rewind check_closed raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos= @io.pos = @orig_pos @read = 0 end |