Class: Archive::Tar::Minitar::Reader::EntryStream

Inherits:
Object
  • Object
show all
Includes:
ByteSize
Defined in:
lib/archive/tar/minitar/reader.rb

Overview

EntryStreams are pseudo-streams on top of the main data stream.

Instance Method Summary collapse

Constructor Details

#initialize(header, io) ⇒ EntryStream

Returns a new instance of EntryStream.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/archive/tar/minitar/reader.rb', line 32

def initialize(header, io)
  @io       = io
  @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 =
    if Archive::Tar::Minitar.seekable?(@io)
      @io.pos
    else
      0
    end
end

Instance Method Details

#bytes_read ⇒ Object 



122
123
124
 
# File 'lib/archive/tar/minitar/reader.rb', line 122

def bytes_read
  @read
end

#close ⇒ Object

Closes the entry.



141
142
143
 
# File 'lib/archive/tar/minitar/reader.rb', line 141

def close
  invalidate
end

#closed? ⇒ Boolean

Returns false if the entry stream is valid.

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/archive/tar/minitar/reader.rb', line 136

def closed?
  false
end

#directory? ⇒ Boolean Also known as: directory

Returns true if the entry represents a directory.

Returns:

  • (Boolean) 


80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/archive/tar/minitar/reader.rb', line 80

def directory?
  case @typeflag
  when '5'
    true
  when '0', "\0"
    # If the name ends with a slash, treat it as a directory.
    # This is what other major tar implementations do for
    # interoperability and compatibility with older tar variants
    # and some new ones.
    @name.end_with?('/')
  else
    false
  end
end

#eof? ⇒ Boolean

Returns true if the current read pointer is at the end of the EntryStream data.

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/archive/tar/minitar/reader.rb', line 104

def eof?
  @read >= @size
end

#file? ⇒ Boolean Also known as: file

Returns true if the entry represents a plain file.

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/archive/tar/minitar/reader.rb', line 97

def file?
  (@typeflag == '0' || @typeflag == "\0") && !@name.end_with?('/')
end

#full_name ⇒ Object

Returns the full and proper name of the entry.



127
128
129
130
131
132
133
 
# File 'lib/archive/tar/minitar/reader.rb', line 127

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.



72
73
74
75
76
77
 
# File 'lib/archive/tar/minitar/reader.rb', line 72

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.



109
110
111
 
# File 'lib/archive/tar/minitar/reader.rb', line 109

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.



61
62
63
64
65
66
67
68
 
# File 'lib/archive/tar/minitar/reader.rb', line 61

def read(len = nil)
  return nil if @read >= @size
  len ||= @size - @read
  max_read = [len, @size - @read].min
  ret = @io.read(max_read)
  @read += bytesize(ret)
  ret
end

#rewind ⇒ Object

Sets the current read pointer to the beginning of the EntryStream.



114
115
116
117
118
119
120
 
# File 'lib/archive/tar/minitar/reader.rb', line 114

def rewind
  unless Archive::Tar::Minitar.seekable?(@io, :pos=)
    raise Archive::Tar::Minitar::NonSeekableStream
  end
  @io.pos = @orig_pos
  @read = 0
end