Class: FormatParser::ZIPParser::FileReader::ZipEntry

Inherits:
Object
  • Object
show all
Includes:
AttributesJSON
Defined in:
lib/parsers/zip_parser/file_reader.rb

Overview

Represents a file within the ZIP archive being read

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from AttributesJSON

#as_json, #to_json

Instance Attribute Details

#comment ⇒ String

Returns the file comment.

Returns:

  • (String) —

    the file comment



124
125
126
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 124

def comment
  @comment
end

#compressed_size ⇒ Fixnum

Returns size of compressed file data in the ZIP.

Returns:

  • (Fixnum) —

    size of compressed file data in the ZIP



102
103
104
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 102

def compressed_size
  @compressed_size
end

#crc32 ⇒ Fixnum

Returns the CRC32 checksum of this file.

Returns:

  • (Fixnum) —

    the CRC32 checksum of this file



99
100
101
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 99

def crc32
  @crc32
end

#disk_number_start ⇒ Fixnum

Returns disk number where this file starts.

Returns:

  • (Fixnum) —

    disk number where this file starts



111
112
113
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 111

def disk_number_start
  @disk_number_start
end

#dos_date ⇒ Fixnum

Returns the bit-packed DOS date.

Returns:

  • (Fixnum) —

    the bit-packed DOS date



96
97
98
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 96

def dos_date
  @dos_date
end

#dos_time ⇒ Fixnum

Returns the bit-packed DOS time.

Returns:

  • (Fixnum) —

    the bit-packed DOS time



93
94
95
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 93

def dos_time
  @dos_time
end

#external_attrs ⇒ Fixnum

Returns external attributes of the file.

Returns:

  • (Fixnum) —

    external attributes of the file



117
118
119
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 117

def external_attrs
  @external_attrs
end

#filename ⇒ String

Returns the filename.

Returns:

  • (String) —

    the filename



108
109
110
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 108

def filename
  @filename
end

#gp_flags ⇒ Fixnum

Returns bit-packed general purpose flags.

Returns:

  • (Fixnum) —

    bit-packed general purpose flags



87
88
89
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 87

def gp_flags
  @gp_flags
end

#internal_attrs ⇒ Fixnum

Returns internal attributes of the file.

Returns:

  • (Fixnum) —

    internal attributes of the file



114
115
116
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 114

def internal_attrs
  @internal_attrs
end

#local_file_header_offset ⇒ Fixnum

Returns at what offset the local file header starts in your original IO object.

Returns:

  • (Fixnum) —

    at what offset the local file header starts in your original IO object



121
122
123
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 121

def local_file_header_offset
  @local_file_header_offset
end

#made_by ⇒ Fixnum

Returns bit-packed version signature of the program that made the archive.

Returns:

  • (Fixnum) —

    bit-packed version signature of the program that made the archive



81
82
83
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 81

def made_by
  @made_by
end

#storage_mode ⇒ Fixnum

Returns Storage mode (0 for stored, 8 for deflate).

Returns:

  • (Fixnum) —

    Storage mode (0 for stored, 8 for deflate)



90
91
92
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 90

def storage_mode
  @storage_mode
end

#uncompressed_size ⇒ Fixnum

Returns size of the file once uncompressed.

Returns:

  • (Fixnum) —

    size of the file once uncompressed



105
106
107
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 105

def uncompressed_size
  @uncompressed_size
end

#version_needed_to_extract ⇒ Fixnum

Returns ZIP version support needed to extract this file.

Returns:

  • (Fixnum) —

    ZIP version support needed to extract this file



84
85
86
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 84

def version_needed_to_extract
  @version_needed_to_extract
end

Instance Method Details

#compressed_data_offset ⇒ Fixnum

Returns at what offset you should start reading for the compressed data in your original IO object.

Returns:

  • (Fixnum) —

    at what offset you should start reading for the compressed data in your original IO object



128
129
130
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 128

def compressed_data_offset
  @compressed_data_offset || raise(LocalHeaderPending)
end

#compressed_data_offset=(offset) ⇒ Object

Sets the offset at which the compressed data for this file starts in the ZIP. By default, the value will be set by the Reader for you. If you use delayed reading, you need to set it by using the ‘get_compressed_data_offset` on the Reader:

entry.compressed_data_offset = reader.get_compressed_data_offset(io: file,
       local_file_header_offset: entry.local_header_offset)



150
151
152
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 150

def compressed_data_offset=(offset)
  @compressed_data_offset = offset.to_i
end

#known_offset? ⇒ Boolean

Tells whether the compressed data offset is already known for this entry

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 134

def known_offset?
  !@compressed_data_offset.nil?
end

#uses_data_descriptor? ⇒ Boolean

Tells whether the entry uses a data descriptor (this is defined by bit 3 in the GP flags).

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/parsers/zip_parser/file_reader.rb', line 140

def uses_data_descriptor?
  (gp_flags & 0x0008) == 0x0008
end