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

Constant Summary

Constants included from AttributesJSON

AttributesJSON::MAXIMUM_JSON_NESTING_WHEN_SANITIZING

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from AttributesJSON

_sanitize_json_value, #as_json, #to_json

Instance Attribute Details

#comment ⇒ String

Returns the file comment.

Returns:

  • (String) —

    the file comment



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

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



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

def compressed_size
  @compressed_size
end

#crc32 ⇒ Fixnum

Returns the CRC32 checksum of this file.

Returns:

  • (Fixnum) —

    the CRC32 checksum of this file



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

def crc32
  @crc32
end

#disk_number_start ⇒ Fixnum

Returns disk number where this file starts.

Returns:

  • (Fixnum) —

    disk number where this file starts



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

def disk_number_start
  @disk_number_start
end

#dos_date ⇒ Fixnum

Returns the bit-packed DOS date.

Returns:

  • (Fixnum) —

    the bit-packed DOS date



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

def dos_date
  @dos_date
end

#dos_time ⇒ Fixnum

Returns the bit-packed DOS time.

Returns:

  • (Fixnum) —

    the bit-packed DOS time



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

def dos_time
  @dos_time
end

#external_attrs ⇒ Fixnum

Returns external attributes of the file.

Returns:

  • (Fixnum) —

    external attributes of the file



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

def external_attrs
  @external_attrs
end

#filename ⇒ String

Returns the filename.

Returns:

  • (String) —

    the filename



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

def filename
  @filename
end

#gp_flags ⇒ Fixnum

Returns bit-packed general purpose flags.

Returns:

  • (Fixnum) —

    bit-packed general purpose flags



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

def gp_flags
  @gp_flags
end

#internal_attrs ⇒ Fixnum

Returns internal attributes of the file.

Returns:

  • (Fixnum) —

    internal attributes of the file



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

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



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

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



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

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)



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

def storage_mode
  @storage_mode
end

#uncompressed_size ⇒ Fixnum

Returns size of the file once uncompressed.

Returns:

  • (Fixnum) —

    size of the file once uncompressed



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

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



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

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



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

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)



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

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) 


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

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) 


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

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