Class: Archive::Tar::Minitar::Reader::EntryStream
- Inherits:
-
Object
- Object
- Archive::Tar::Minitar::Reader::EntryStream
- Defined in:
- lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb
Overview
EntryStreams are pseudo-streams on top of the main data stream.
Instance Method Summary collapse
- #bytes_read ⇒ Object
-
#close ⇒ Object
Closes the entry.
-
#directory? ⇒ Boolean
(also: #directory)
Returns
true
if the entry represents a directory. -
#eof? ⇒ Boolean
Returns
true
if the current read pointer is at the end of the EntryStream data. -
#file? ⇒ Boolean
(also: #file)
Returns
true
if the entry represents a plain file. -
#full_name ⇒ Object
Returns the full and proper name of the entry.
-
#getc ⇒ Object
Reads one byte from the entry.
-
#initialize(header, anIO) ⇒ EntryStream
constructor
A new instance of EntryStream.
-
#pos ⇒ Object
Returns the current read pointer in the EntryStream.
-
#read(len = nil) ⇒ Object
Reads
len
bytes (or all remaining data) from the entry. -
#rewind ⇒ Object
Sets the current read pointer to the beginning of the EntryStream.
Constructor Details
#initialize(header, anIO) ⇒ EntryStream
Returns a new instance of EntryStream.
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 464 def initialize(header, anIO) @io = anIO @name = header.name @mode = header.mode @uid = header.uid @gid = header.gid @size = header.size @mtime = header.mtime @checksum = header.checksum @typeflag = header.typeflag @linkname = header.linkname @magic = header.magic @version = header.version @uname = header.uname @gname = header.gname @devmajor = header.devmajor @devminor = header.devminor @prefix = header.prefix @read = 0 @orig_pos = @io.pos end |
Instance Method Details
#bytes_read ⇒ Object
536 537 538 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 536 def bytes_read @read end |
#close ⇒ Object
Closes the entry.
550 551 552 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 550 def close invalidate end |
#directory? ⇒ Boolean Also known as: directory
Returns true
if the entry represents a directory.
507 508 509 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 507 def directory? @typeflag == "5" end |
#eof? ⇒ Boolean
Returns true
if the current read pointer is at the end of the EntryStream data.
520 521 522 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 520 def eof? @read >= @size end |
#file? ⇒ Boolean Also known as: file
Returns true
if the entry represents a plain file.
513 514 515 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 513 def file? @typeflag == "0" end |
#full_name ⇒ Object
Returns the full and proper name of the entry.
541 542 543 544 545 546 547 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 541 def full_name if @prefix != "" File.join(@prefix, @name) else @name end end |
#getc ⇒ Object
Reads one byte from the entry. Returns nil
if there is no more data to read.
499 500 501 502 503 504 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 499 def getc return nil if @read >= @size ret = @io.getc @read += 1 if ret ret end |
#pos ⇒ Object
Returns the current read pointer in the EntryStream.
525 526 527 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 525 def pos @read end |
#read(len = nil) ⇒ Object
Reads len
bytes (or all remaining data) from the entry. Returns nil
if there is no more data to read.
488 489 490 491 492 493 494 495 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 488 def read(len = nil) return nil if @read >= @size len ||= @size - @read max_read = [len, @size - @read].min ret = @io.read(max_read) @read += ret.size ret end |
#rewind ⇒ Object
Sets the current read pointer to the beginning of the EntryStream.
530 531 532 533 534 |
# File 'lib/gems/archive-tar-minitar-0.5.2/lib/archive/tar/minitar.rb', line 530 def rewind raise NonSeekableStream unless @io.respond_to?(:pos=) @io.pos = @orig_pos @read = 0 end |