A Struct is an ordered collection of named data objects.
require 'bindata' class Tuple < BinData::Record int8 :x int8 :y int8 :z end obj = BinData::Struct.new(:hide => :a, :fields => [ [:int32le, :a], [:int16le, :b], [:tuple, :s] ]) obj.field_names =># [:b, :s]
Parameters may be provided at initialisation to control the behaviour of an object. These params are:
:fields |
An array specifying the fields for this struct. Each element of the array is of the form [type, name, params]. Type is a symbol representing a registered type. Name is the name of this field. Params is an optional hash of parameters to pass to this field when instantiating it. If name is “” or nil, then that field is anonymous and behaves as a hidden field. |
:hide |
A list of the names of fields that are to be hidden from the outside world. Hidden fields don’t appear in snapshot or field_names but are still accessible by name. |
:endian |
Either :little or :big. This specifies the default endian of any numerics in this struct, or in any nested data objects. |
Fields may have have extra parameters as listed below:
These reserved words may not be used as field names
# File lib/bindata/struct.rb, line 144 def [](key) find_obj_for_name(key) end
# File lib/bindata/struct.rb, line 148 def []=(key, value) obj = find_obj_for_name(key) if obj obj.assign(value) end end
# File lib/bindata/struct.rb, line 92 def assign(val) clear assign_fields(val) end
# File lib/bindata/struct.rb, line 134 def do_write(io) #:nodoc instantiate_all_objs @field_objs.each { |f| f.do_write(io) if include_obj?(f) } end
# File lib/bindata/struct.rb, line 159 def each_pair @field_names.compact.each do |name| yield [name, find_obj_for_name(name)] end end
Returns a list of the names of all fields accessible through this object. include_hidden specifies whether to include hidden names in the listing.
# File lib/bindata/struct.rb, line 109 def field_names(include_hidden = false) if include_hidden @field_names.compact else hidden = get_parameter(:hide) || [] @field_names.compact - hidden end end
# File lib/bindata/struct.rb, line 155 def has_key?(key) @field_names.index(base_field_name(key)) end
Generated with the Darkfish Rdoc Generator 2.