Class: Erlang::ETF::Compressed

Inherits:
Object
  • Object
show all
Includes:
Term
Defined in:
lib/erlang/etf/compressed.rb

Overview

1 4 N
80 UncompressedSize Zlib-compressedData

Uncompressed Size (unsigned 32 bit integer in big-endian byte order) is the size of the data before it was compressed. The compressed data has the following format when it has been expanded:

1 Uncompressed Size
Tag Data

(see External Term Format and term_to_binary/2)

Constant Summary collapse

LEVEL_RANGE = 
(0..9).freeze
LEVEL_DEFAULT = 
6.freeze
UINT32BE = 
Erlang::ETF::Term::UINT32BE

Constants included from Term

Term::ATOM_CACHE_REF, Term::ATOM_EXT, Term::ATOM_INTERNAL_REF2, Term::ATOM_INTERNAL_REF3, Term::ATOM_UTF8_EXT, Term::BINARY_ENCODING, Term::BINARY_EXT, Term::BINARY_INTERNAL_REF, Term::BIT_BINARY_EXT, Term::BIT_BINARY_INTERNAL_REF, Term::COMPRESSED, Term::DIST_HEADER, Term::DOUBLE, Term::DOUBLEBE, Term::DOUBLELE, Term::ERLANG_MAGIC_BYTE, Term::EXPORT_EXT, Term::FLOAT_EXT, Term::FUN_EXT, Term::INT128, Term::INT128BE, Term::INT128LE, Term::INT16, Term::INT16BE, Term::INT16LE, Term::INT32, Term::INT32BE, Term::INT32LE, Term::INT64, Term::INT64BE, Term::INT64LE, Term::INT8, Term::INTEGER_EXT, Term::LARGE_BIG_EXT, Term::LARGE_TUPLE_EXT, Term::LIST_EXT, Term::MAP_EXT, Term::NEW_FLOAT_EXT, Term::NEW_FUN_EXT, Term::NEW_REFERENCE_EXT, Term::NIL_EXT, Term::PID_EXT, Term::PORT_EXT, Term::REFERENCE_EXT, Term::SINGLE, Term::SINGLEBE, Term::SINGLELE, Term::SMALL_ATOM_EXT, Term::SMALL_ATOM_UTF8_EXT, Term::SMALL_BIG_EXT, Term::SMALL_INTEGER_EXT, Term::SMALL_TUPLE_EXT, Term::STRING_EXT, Term::UINT128, Term::UINT128BE, Term::UINT128LE, Term::UINT16, Term::UINT16BE, Term::UINT16LE, Term::UINT32, Term::UINT32LE, Term::UINT64, Term::UINT64BE, Term::UINT64LE, Term::UINT8

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Term

#<=>, binary_encoding, #eql?, #erlang_external_type, #hash, included, #to_erlang_etf

Constructor Details

#initialize(term, uncompressed_size = nil, compressed_data = nil, level = LEVEL_DEFAULT) ⇒ Compressed

Returns a new instance of Compressed.

Raises:

  • (ArgumentError) 


51
52
53
54
55
56
57
 
# File 'lib/erlang/etf/compressed.rb', line 51

def initialize(term, uncompressed_size = nil, compressed_data = nil, level = LEVEL_DEFAULT)
  raise ArgumentError, "term must be of any type" if not Erlang.is_any(term)
  @term = term
  @uncompressed_size = uncompressed_size
  @compressed_data = compressed_data
  @level = LEVEL_RANGE.include?(level) ? level : LEVEL_DEFAULT
end

Class Method Details

.[](term, uncompressed_size = nil, compressed_data = nil, level: LEVEL_DEFAULT) ⇒ Object 



33
34
35
36
 
# File 'lib/erlang/etf/compressed.rb', line 33

def [](term, uncompressed_size = nil, compressed_data = nil, level: LEVEL_DEFAULT)
  term = Erlang.from(term)
  return new(term, uncompressed_size, compressed_data, level)
end

.erlang_load(buffer) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/erlang/etf/compressed.rb', line 38

def erlang_load(buffer)
  uncompressed_size, = buffer.read(4).unpack(UINT32BE)
  compressed_data = buffer.read()
  uncompressed_data = ::Zlib::Inflate.inflate(compressed_data)
  if uncompressed_size == uncompressed_data.bytesize
    term = Erlang.from(Erlang::ETF.read_term(StringIO.new(uncompressed_data)))
    return new(term, uncompressed_size, compressed_data)
  else
    raise ::Zlib::DataError, "UncompressedSize value did not match the size of the uncompressed data"
  end
end

Instance Method Details

#erlang_dump(buffer = ::String.new.force_encoding(BINARY_ENCODING)) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/erlang/etf/compressed.rb', line 59

def erlang_dump(buffer = ::String.new.force_encoding(BINARY_ENCODING))
  buffer << COMPRESSED
  if @uncompressed_size.nil? and @compressed_data.nil?
    uncompressed_data = Erlang::ETF.write_term(@term, ::String.new.force_encoding(BINARY_ENCODING))
    uncompressed_size = uncompressed_data.bytesize
    compressed_data = ::Zlib::Deflate.deflate(uncompressed_data, @level)
    buffer << [uncompressed_size].pack(UINT32BE)
    buffer << Erlang::ETF::Term.binary_encoding(compressed_data)
  else
    buffer << [@uncompressed_size].pack(UINT32BE)
    buffer << Erlang::ETF::Term.binary_encoding(@compressed_data)
  end
  return buffer
end

#inspect ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/erlang/etf/compressed.rb', line 74

def inspect
  if @uncompressed_size.nil? and @compressed_data.nil?
    return "#{self.class}[#{@term.inspect}, level: #{@level.inspect}]"
  else
    return "#{self.class}[#{@term.inspect}, #{@uncompressed_size.inspect}, #{@compressed_data.inspect}, level: #{@level.inspect}]"
  end
end

#pretty_print(pp) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/erlang/etf/compressed.rb', line 82

def pretty_print(pp)
  state = [@term]
  state.push(@uncompressed_size, @compressed_data) if not @uncompressed_size.nil? or not @compressed_data.nil?
  return pp.group(1, "#{self.class}[", ", level: #{@level.inspect}]") do
    pp.breakable ''
    pp.seplist(state) { |obj| obj.pretty_print(pp) }
  end
end