Class: Erlang::ETF::Reference

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

Overview

1 N 4 1
101 Node ID Creation

Encode a reference object (an object generated with make_ref/0). The Node term is an encoded atom, i.e. ATOM_EXT, SMALL_ATOM_EXT or ATOM_CACHE_REF. The ID field contains a big-endian unsigned integer, but should be regarded as uninterpreted data since this field is node specific. Creation is a byte containing a node serial number that makes it possible to separate old (crashed) nodes from a new one.

In ID, only 18 bits are significant; the rest should be 0. In Creation, only 2 bits are significant; the rest should be 0. See NEW_REFERENCE_EXT.

(see REFERENCE_EXT)

Constant Summary collapse

UINT8 = 
Erlang::ETF::Term::UINT8
UINT32BE = 
Erlang::ETF::Term::UINT32BE
HEAD = 
(UINT32BE + UINT8).freeze

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

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, node = nil, id = nil, creation = nil) ⇒ Reference

Returns a new instance of Reference.

Raises:

  • (ArgumentError) 


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

def initialize(term, node = nil, id = nil, creation = nil)
  raise ArgumentError, "term must be of type Erlang::Reference" if not term.kind_of?(Erlang::Reference) or term.new_reference?
  @term     = term
  @node     = node
  @id       = id
  @creation = creation
end

Class Method Details

.[](term, node = nil, id = nil, creation = nil) ⇒ Object 



38
39
40
 
# File 'lib/erlang/etf/reference.rb', line 38

def [](term, node = nil, id = nil, creation = nil)
  return new(term, node, id, creation)
end

.erlang_load(buffer) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/erlang/etf/reference.rb', line 42

def erlang_load(buffer)
  node = Erlang::ETF.read_term(buffer)
  id, creation = buffer.read(5).unpack(HEAD)
  term = Erlang::Reference[Erlang.from(node), Erlang.from(creation), Erlang.from(id)]
  return new(term, node, id, creation)
end

Instance Method Details

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



58
59
60
61
62
63
64
65
66
 
# File 'lib/erlang/etf/reference.rb', line 58

def erlang_dump(buffer = ::String.new.force_encoding(BINARY_ENCODING))
  buffer << REFERENCE_EXT
  Erlang::ETF.write_term(@node || @term.node, buffer)
  buffer << [
    @id       || @term.id,
    @creation || @term.creation
  ].pack(HEAD)
  return buffer
end

#inspect ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/erlang/etf/reference.rb', line 68

def inspect
  if @node.nil? and @id.nil? and @creation.nil?
    return super
  else
    return "#{self.class}[#{@term.inspect}, #{@node.inspect}, #{@id.inspect}, #{@creation.inspect}]"
  end
end

#pretty_print(pp) ⇒ Object 



76
77
78
79
80
81
82
83
 
# File 'lib/erlang/etf/reference.rb', line 76

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