Class: Erlang::ETF::Atom

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

Overview

1 2 Len
100 Len AtomName

An atom is stored with a 2 byte unsigned length in big-endian order, followed by Len numbers of 8 bit Latin1 characters that forms the AtomName.

Note: The maximum allowed value for Len is 255.

(see ATOM_EXT)

Constant Summary collapse

UINT16BE = 
Erlang::ETF::Term::UINT16BE

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::UINT16LE, Term::UINT32, Term::UINT32BE, 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, #inspect, #to_erlang_etf

Constructor Details

#initialize(term) ⇒ Atom

Returns a new instance of Atom.

Raises:

  • (ArgumentError) 


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

def initialize(term)
  raise ArgumentError, "term must be of type Erlang::Atom" if not term.kind_of?(Erlang::Atom)
  @term = term
end

Class Method Details

.[](term) ⇒ Object 



25
26
27
28
29
 
# File 'lib/erlang/etf/atom.rb', line 25

def [](term)
  return term if term.kind_of?(Erlang::ETF::Term)
  term = Erlang.from(term) if not term.kind_of?(Erlang::Atom)
  return new(term)
end

.erlang_load(buffer) ⇒ Object 



31
32
33
34
35
 
# File 'lib/erlang/etf/atom.rb', line 31

def erlang_load(buffer)
  size, = buffer.read(2).unpack(UINT16BE)
  data = buffer.read(size)
  return new(Erlang::Atom[data])
end

Instance Method Details

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



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

def erlang_dump(buffer = ::String.new.force_encoding(BINARY_ENCODING))
  buffer << ATOM_EXT
  buffer << [@term.size].pack(UINT16BE)
  buffer << Erlang::ETF::Term.binary_encoding(@term.data)
  return buffer
end