Class
for reading entries out of a tar file
- B
- C
- D
- E
- F
- G
- L
- N
- O
- P
- R
- S
Attributes
[R] | header | Header for this tar entry |
Class Public methods
new(header, io) Link
Creates a new tar entry for header
that will be read from io
open(header, io, &block) Link
Creates a new tar entry for header
that will be read from io
If a block is given, the entry is yielded and then closed.
Instance Public methods
bytes_read() Link
Number of bytes read out of the tar entry
close() Link
Closes the tar entry
closed?() Link
Is the tar entry closed?
directory?() Link
Is this tar entry a directory?
eof?() Link
Are we at the end of the tar entry?
file?() Link
Is this tar entry a file?
full_name() Link
Full name of the tar entry
# File ruby/lib/rubygems/package/tar_reader/entry.rb, line 89 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() Link
Read one byte from the tar entry
pos() Link
The position in the tar entry
pos=(new_pos) Link
Seek to the position in the tar entry
read(maxlen = nil) Link
Reads maxlen
bytes from the tar file entry, or the rest of the entry if nil
# File ruby/lib/rubygems/package/tar_reader/entry.rb, line 159 def read(maxlen = nil) if eof? return maxlen.to_i.zero? ? "" : nil end max_read = [maxlen, @header.size - @read].compact.min ret = @io.read max_read if ret.nil? return maxlen ? nil : "" # IO.read returns nil on EOF with len argument end @read += ret.size ret end
readpartial(maxlen, outbuf = "".b) Link
# File ruby/lib/rubygems/package/tar_reader/entry.rb, line 175 def readpartial(maxlen, outbuf = "".b) if eof? && maxlen > 0 raise EOFError, "end of file reached" end max_read = [maxlen, @header.size - @read].min @io.readpartial(max_read, outbuf) @read += outbuf.size outbuf end
rewind() Link
Rewinds to the beginning of the tar file entry
seek(offset, whence = IO::SEEK_SET) Link
Seeks to offset
bytes into the tar file entry whence
can be IO::SEEK_SET, IO::SEEK_CUR, or IO::SEEK_END
# File ruby/lib/rubygems/package/tar_reader/entry.rb, line 192 def seek(offset, whence = IO::SEEK_SET) check_closed new_pos = case whence when IO::SEEK_SET then @orig_pos + offset when IO::SEEK_CUR then @io.pos + offset when IO::SEEK_END then @end_pos + offset else raise ArgumentError, "invalid whence" end if new_pos < @orig_pos new_pos = @orig_pos elsif new_pos > @end_pos new_pos = @end_pos end pending = new_pos - @io.pos return 0 if pending == 0 if @io.respond_to?(:seek) begin # avoid reading if the @io supports seeking @io.seek new_pos, IO::SEEK_SET pending = 0 rescue Errno::EINVAL end end # if seeking isn't supported or failed # negative seek requires that we rewind and read if pending < 0 @io.rewind pending = new_pos end while pending > 0 do size_read = @io.read([pending, 4096].min)&.size raise(EOFError, "end of file reached") if size_read.nil? pending -= size_read end @read = @io.pos - @orig_pos 0 end