Class: HMap::HMapStructure Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/hmap/hmap/hmap_struct.rb

Overview

This class is abstract.

A general purpose pseudo-structure.

Direct Known Subclasses

HMapBucket, HMapHeader

Constant Summary collapse

FORMAT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The String#unpack format of the data structure.

Returns:

  • (String) —

    the unpacking format

''
SIZEOF =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The size of the data structure, in bytes.

Returns:

  • (Integer) —

    the size, in bytes

0
SWAPPED = 
true

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.bytesize ⇒ Integer

Returns the size, in bytes, of the represented structure.

Returns:

  • (Integer) —

    the size, in bytes, of the represented structure.



31
32
33
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 31

def self.bytesize
  self::SIZEOF
end

.format ⇒ Object 



35
36
37
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 35

def self.format
  self::FORMAT
end

.new_from_bin(swapped, bin) ⇒ HMap::HMapStructure

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the resulting structure.

Parameters:

  • endianness (Symbol) —

    either ‘:big` or `:little`

  • bin (String) —

    the string to be unpacked into the new structure

Returns:



47
48
49
50
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 47

def self.new_from_bin(swapped, bin)
  format = Utils.specialize_format(self::FORMAT, swapped)
  new(*bin.unpack(format))
end

.swapped? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 39

def self.swapped?
  self::SWAPPED
end

Instance Method Details

#serialize ⇒ Object 



52
53
54
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 52

def serialize
  [].pack(format)
end

#to_h ⇒ Hash

Returns a hash representation of this HMap::HMapStructure.

Returns:



57
58
59
60
61
62
63
64
 
# File 'lib/hmap/hmap/hmap_struct.rb', line 57

def to_h
  {
    'structure' => {
      'format' => self.class::FORMAT,
      'bytesize' => self.class.bytesize
    }
  }
end