Table of Contents - bindata-2.4.3 Documentation
Pages
NEWS
2.4.0
2.3.x
2.4.0
2.3.0
2.1.0
Deprecations
2.0.0
1.6.0
1.5.0
1.4.4
Deprecations
1.4.0
Deprecations
1.3.0
New features
Backwards incompatible changes
1.0.0
0.10.0
IMPORTANT - Ruby does not warn you about this change!
Deprecations. Ruby will warn you of these when in $VERBOSE mode.
Classes/Modules
BinData
BinData::AcceptedParametersPlugin
BinData::AcceptedParametersPlugin::AcceptedParameters
BinData::Array
Parameters
BinData::ArrayArgProcessor
BinData::Base
BinData::Base::AutoCallDelayedIO
BinData::BaseArgProcessor
BinData::BasePrimitive
Parameters
BinData::BasePrimitive::AssertPlugin
BinData::BasePrimitive::AssertedValuePlugin
BinData::BasePrimitive::InitialValuePlugin
BinData::BasePrimitive::ValuePlugin
BinData::BitAligned
BinData::BitAligned::BitAlignedIO
BinData::BitField
BinData::BitFieldFactory
BinData::Buffer
Parameters
BinData::BufferArgProcessor
BinData::ByteAlignPlugin
BinData::CheckOrAdjustOffsetPlugin
Parameters
BinData::CheckOrAdjustOffsetPlugin::AdjustOffsetMixin
BinData::CheckOrAdjustOffsetPlugin::CheckOffsetMixin
BinData::Choice
Parameters
BinData::ChoiceArgProcessor
BinData::CopyOnChangePlugin
BinData::CountBytesRemaining
BinData::DSLMixin
BinData::DSLMixin::DSLBigAndLittleEndianHandler
BinData::DSLMixin::DSLFieldParser
BinData::DSLMixin::DSLFieldValidator
BinData::DSLMixin::DSLParser
BinData::DelayedIO
Parameters
BinData::DelayedIoArgProcessor
BinData::DoubleBe
BinData::DoubleLe
BinData::FloatBe
BinData::FloatLe
BinData::FloatingPoint
BinData::Framework
BinData::IO
BinData::IO::Common
BinData::IO::Common::SeekableStream
BinData::IO::Common::UnSeekableStream
BinData::IO::Read
BinData::IO::Write
BinData::InitialLengthPlugin
BinData::Int
BinData::Int8
BinData::IntFactory
BinData::LazyEvaluator
BinData::MultiFieldArgSeparator
BinData::Primitive
Parameters
BinData::PrimitiveArgProcessor
BinData::ReadUntilEOFPlugin
BinData::ReadUntilPlugin
BinData::Record
BinData::RecordArgProcessor
BinData::RegisterNamePlugin
Parameters
BinData::Registry
BinData::Rest
BinData::ResumeByteAlignment
BinData::SanitizedBigEndian
BinData::SanitizedChoices
BinData::SanitizedField
BinData::SanitizedFields
BinData::SanitizedLittleEndian
BinData::SanitizedParameter
BinData::SanitizedParameters
BinData::SanitizedPrototype
BinData::Skip
Parameters
BinData::SkipArgProcessor
BinData::SkipLengthPlugin
BinData::SkipToAbsOffsetPlugin
BinData::SkipUntilValidPlugin
BinData::String
Parameters
BinData::StringArgProcessor
BinData::Stringz
Parameters
BinData::Struct
Parameters
Field Parameters
BinData::Struct::Snapshot
BinData::StructArgProcessor
BinData::Tracer
BinData::Uint8
BinData::Uint8Array
Parameters
BinData::Uint8ArrayArgProcessor
BinData::UnRegisteredTypeError
BinData::ValidityError
BinData::Virtual
Parameters
BinData::WarnNoReadLengthPlugin
Methods
::arg_processor — BinData::Base
::auto_call_delayed_io — BinData::Base
::bindata_name — BinData::Base
::bit_aligned — BinData::Primitive
::bit_aligned — BinData::BasePrimitive
::class_with_endian — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::create_string_io — BinData::IO
::create_subclasses_with_endian — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::delegate_field_creation — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::fixup_subclass_hierarchy — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::handle — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::invalid_parameter_names — BinData::AcceptedParametersPlugin::AcceptedParameters
::make_class_abstract — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::new — BinData::Registry
::new — BinData::Base
::new — BinData::SanitizedChoices
::new — BinData::SanitizedParameters
::new — BinData::IO::Common
::new — BinData::BitAligned::BitAlignedIO
::new — BinData::DSLMixin::DSLParser
::new — BinData::SanitizedFields
::new — BinData::AcceptedParametersPlugin::AcceptedParameters
::new — BinData::LazyEvaluator
::new — BinData::IO::Write
::new — BinData::SanitizedField
::new — BinData::DSLMixin::DSLFieldParser
::new — BinData::SanitizedPrototype
::new — BinData::IO::Read
::new — BinData::DSLMixin::DSLFieldValidator
::obj_attribute — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::override_new_in_class — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::read — BinData::Base
::sanitize — BinData::SanitizedParameters
::trace_reading — BinData
::turn_off_tracing — BinData::Choice
::turn_off_tracing — BinData::BasePrimitive
::turn_on_tracing — BinData::BasePrimitive
::turn_on_tracing — BinData::Choice
::unregister_self — BinData::Base
#<< — BinData::Array
#<=> — BinData::BasePrimitive
#=~ — BinData::Base
#[] — BinData::SanitizedFields
#[] — BinData::Array
#[] — BinData::Struct
#[] — BinData::SanitizedChoices
#[]= — BinData::Struct
#[]= — BinData::Array
#_value — BinData::BasePrimitive::ValuePlugin
#_value — BinData::BasePrimitive::InitialValuePlugin
#_value — BinData::BasePrimitive::AssertedValuePlugin
#_value — BinData::BasePrimitive
#abs_offset — BinData::Base
#abs_offset — BinData::DelayedIO
#abs_offset= — BinData::DelayedIO
#accumulate_big_endian_bits — BinData::IO::Read
#accumulate_little_endian_bits — BinData::IO::Read
#add_field — BinData::SanitizedFields
#adjust_offset — BinData::CheckOrAdjustOffsetPlugin::AdjustOffsetMixin
#align_obj? — BinData::ByteAlignPlugin
#all — BinData::AcceptedParametersPlugin::AcceptedParameters
#all_field_names_blank? — BinData::SanitizedFields
#all_or_none_names_failed? — BinData::DSLMixin::DSLFieldValidator
#any_field_has_parameter? — BinData::SanitizedFields
#append_field — BinData::DSLMixin::DSLParser
#append_new_element — BinData::Array
#append_zero_byte_if_needed! — BinData::Stringz
#as_stringified_hash — BinData::Struct
#assert! — BinData::BasePrimitive::AssertPlugin
#assert! — BinData::BasePrimitive::AssertedValuePlugin
#assert_value — BinData::BasePrimitive::AssertedValuePlugin
#assign — BinData::BasePrimitive::AssertPlugin
#assign — BinData::Primitive
#assign — BinData::Buffer
#assign — BinData::DelayedIO
#assign — BinData::Stringz
#assign — BinData::ResumeByteAlignment
#assign — BinData::Array
#assign — BinData::BasePrimitive::ValuePlugin
#assign — BinData::BasePrimitive
#assign — BinData::Struct
#assign — BinData::String
#assign — BinData::BasePrimitive::AssertedValuePlugin
#assign — BinData::Framework
#assign_fields — BinData::Struct
#at — BinData::Array
#base_field_name — BinData::Struct
#binary_string — BinData::Base
#bit_aligned? — BinData::BitAligned
#bit_aligned? — BinData::Framework
#buffer_limited_n — BinData::IO::Common
#bytes_to_align — BinData::ByteAlignPlugin
#callable? — BinData::LazyEvaluator
#check_offset — BinData::CheckOrAdjustOffsetPlugin::CheckOffsetMixin
#choices_as_hash — BinData::ChoiceArgProcessor
#clamp_to_length — BinData::String
#clear — BinData::Base
#clear? — BinData::Buffer
#clear? — BinData::DelayedIO
#clear? — BinData::Array
#clear? — BinData::Framework
#clear? — BinData::ResumeByteAlignment
#concat — BinData::Array
#const_missing — BinData::BitFieldFactory
#const_missing — BinData::IntFactory
#copy_previous_value — BinData::CopyOnChangePlugin
#create_sanitized_choices — BinData::SanitizedParameters
#create_sanitized_endian — BinData::SanitizedParameters
#create_sanitized_fields — BinData::SanitizedParameters
#create_sanitized_object_prototype — BinData::SanitizedParameters
#create_sanitized_params — BinData::SanitizedParameters
#current_choice — BinData::CopyOnChangePlugin
#current_choice — BinData::Choice
#debug_name — BinData::Base
#default — BinData::AcceptedParametersPlugin::AcceptedParameters
#default_parameter — BinData::AcceptedParametersPlugin
#default_parameters — BinData::AcceptedParametersPlugin
#define_field_accessors — BinData::Struct
#define_field_accessors_for — BinData::Struct
#do_num_bytes — BinData::BitAligned
#do_num_bytes — BinData::Primitive
#do_num_bytes — BinData::ResumeByteAlignment
#do_num_bytes — BinData::Virtual
#do_read — BinData::ReadUntilPlugin
#do_read — BinData::ReadUntilEOFPlugin
#do_read — BinData::ResumeByteAlignment
#do_read — BinData::ByteAlignPlugin
#do_read — BinData::InitialLengthPlugin
#do_read — BinData::Virtual
#do_read_with_hook — BinData::Choice
#do_read_with_hook — BinData::BasePrimitive
#do_write — BinData::Struct
#do_write — BinData::Primitive
#do_write — BinData::ResumeByteAlignment
#do_write — BinData::ByteAlignPlugin
#do_write — BinData::Virtual
#do_write — BinData::BitAligned
#dsl_params — BinData::DSLMixin::DSLParser
#dsl_parser — BinData::DSLMixin
#dsl_raise — BinData::DSLMixin::DSLParser
#duplicate_name? — BinData::DSLMixin::DSLFieldValidator
#each — BinData::SanitizedFields
#each — BinData::Array
#each_pair — BinData::Struct
#elements — BinData::InitialLengthPlugin
#elements — BinData::Array
#empty? — BinData::SanitizedFields
#empty? — BinData::Array
#endian — BinData::SanitizedLittleEndian
#endian — BinData::SanitizedBigEndian
#endian — BinData::DSLMixin::DSLParser
#ensure_field_names_are_valid — BinData::StructArgProcessor
#ensure_hints — BinData::DSLMixin::DSLParser
#ensure_mandatory_parameters_exist — BinData::SanitizedParameters
#ensure_mutual_exclusion_of_parameters — BinData::SanitizedParameters
#ensure_no_nil_values — BinData::SanitizedParameters
#ensure_valid_keys — BinData::ChoiceArgProcessor
#ensure_valid_name — BinData::DSLMixin::DSLFieldValidator
#ensure_valid_names — BinData::AcceptedParametersPlugin::AcceptedParameters
#eql? — BinData::BasePrimitive
#eval_parameter — BinData::Base
#eval_symbol_in_parent_context — BinData::LazyEvaluator
#extend_array — BinData::Array
#extract_args — BinData::Base
#extract_args — BinData::BaseArgProcessor
#field_name? — BinData::SanitizedFields
#field_names — BinData::SanitizedFields
#field_names — BinData::Struct
#field_names_in_parameters? — BinData::MultiFieldArgSeparator
#fields — BinData::DSLMixin::DSLFieldValidator
#fields — BinData::DSLMixin::DSLParser
#fields? — BinData::DSLMixin::DSLParser
#find_index — BinData::Array
#find_index_of — BinData::Struct
#find_index_of — BinData::Array
#find_obj_for_name — BinData::Struct
#first — BinData::Array
#flush — BinData::IO::Write
#flushbits — BinData::IO::Write
#get — BinData::Primitive
#get_parameter — BinData::Base
#get_previous_choice — BinData::CopyOnChangePlugin
#has_at_least_one_of? — BinData::SanitizedParameters
#has_key? — BinData::Struct
#has_parameter? — BinData::Base
#has_parameter? — BinData::SanitizedPrototype
#has_parameter? — BinData::SanitizedField
#hash — BinData::BasePrimitive
#hidden_field_names — BinData::StructArgProcessor
#hide — BinData::DSLMixin::DSLParser
#hints — BinData::DSLMixin::DSLParser
#hints — BinData::SanitizedParameters
#include_obj? — BinData::Struct
#index — BinData::LazyEvaluator
#index — BinData::Array
#initialize_instance — BinData::DelayedIO
#initialize_instance — BinData::Base
#initialize_instance — BinData::Choice
#initialize_instance — BinData::Primitive
#initialize_instance — BinData::BasePrimitive
#initialize_instance — BinData::Buffer
#initialize_instance — BinData::Struct
#initialize_instance — BinData::Framework
#initialize_instance — BinData::Array
#initialize_shared_instance — BinData::CheckOrAdjustOffsetPlugin
#initialize_shared_instance — BinData::Base::AutoCallDelayedIO
#initialize_shared_instance — BinData::Array
#initialize_shared_instance — BinData::BasePrimitive
#initialize_shared_instance — BinData::Struct
#initialize_shared_instance — BinData::RegisterNamePlugin
#initialize_shared_instance — BinData::Skip
#initialize_shared_instance — BinData::Framework
#initialize_shared_instance — BinData::Choice
#initialize_shared_instance — BinData::String
#initialize_with_warning — BinData::Base
#insert — BinData::Array
#inspect — BinData::Base
#instantiate — BinData::SanitizedPrototype
#instantiate — BinData::SanitizedField
#instantiate_all_objs — BinData::Struct
#instantiate_choice — BinData::Choice
#instantiate_obj_at — BinData::Struct
#key? — BinData::Struct
#key_array_by_index — BinData::ChoiceArgProcessor
#last — BinData::Array
#lazy_eval — BinData::LazyEvaluator
#length — BinData::Array
#length — BinData::SanitizedFields
#lookup — BinData::Registry
#malformed_name? — BinData::DSLMixin::DSLFieldValidator
#mandatory — BinData::AcceptedParametersPlugin::AcceptedParameters
#mandatory_parameter — BinData::AcceptedParametersPlugin
#mandatory_parameters — BinData::AcceptedParametersPlugin
#mask — BinData::IO::Write
#mask — BinData::IO::Read
#merge_default_parameters! — BinData::SanitizedParameters
#method_missing — BinData::LazyEvaluator
#method_missing — BinData::DSLMixin::DSLParser
#must_be_integer — BinData::SanitizedParameters
#must_have_a_name_failed? — BinData::DSLMixin::DSLFieldValidator
#must_not_have_a_name_failed? — BinData::DSLMixin::DSLFieldValidator
#mutually_exclusive — BinData::AcceptedParametersPlugin::AcceptedParameters
#mutually_exclusive_parameters — BinData::AcceptedParametersPlugin
#name — BinData::SanitizedField
#name_as_sym — BinData::SanitizedField
#name_from_field_declaration — BinData::DSLMixin::DSLFieldParser
#name_is_reserved? — BinData::DSLMixin::DSLFieldValidator
#name_shadows_method? — BinData::DSLMixin::DSLFieldValidator
#name_with_endian — BinData::Registry
#name_with_prefix — BinData::Registry
#needs_sanitizing? — BinData::SanitizedParameters
#new — BinData::Base
#new_element — BinData::Array
#no_field_names_blank? — BinData::SanitizedFields
#normalize_name — BinData::Registry
#num_bytes — BinData::DelayedIO
#num_bytes — BinData::Base
#num_bytes — BinData::Base::AutoCallDelayedIO
#num_bytes_remaining — BinData::IO::Common::SeekableStream
#num_bytes_remaining — BinData::IO::Common::UnSeekableStream
#offset — BinData::IO::Read
#offset — BinData::IO::Write
#offset_raw — BinData::IO::Common::UnSeekableStream
#offset_raw — BinData::IO::Common::SeekableStream
#option? — BinData::DSLMixin::DSLFieldValidator
#option? — BinData::DSLMixin::DSLParser
#optional — BinData::AcceptedParametersPlugin::AcceptedParameters
#optional_parameter — BinData::AcceptedParametersPlugin
#optional_parameters — BinData::AcceptedParametersPlugin
#parameters_is_value? — BinData::MultiFieldArgSeparator
#params_from_args — BinData::DSLMixin::DSLFieldParser
#params_from_block — BinData::DSLMixin::DSLFieldParser
#params_from_field_declaration — BinData::DSLMixin::DSLFieldParser
#parent — BinData::LazyEvaluator
#parent_attribute — BinData::DSLMixin::DSLParser
#parent_fields — BinData::DSLMixin::DSLParser
#parse_and_append_field — BinData::DSLMixin::DSLParser
#parser_abilities — BinData::DSLMixin::DSLParser
#push — BinData::Array
#raw_fields — BinData::SanitizedFields
#raw_num_bytes — BinData::Buffer
#read — BinData::Base
#read — BinData::IO::Read
#read — BinData::Base::AutoCallDelayedIO
#read_all_bytes — BinData::IO::Read
#read_and_return_value — BinData::WarnNoReadLengthPlugin
#read_and_return_value — BinData::Uint8Array
#read_and_return_value — BinData::CountBytesRemaining
#read_and_return_value — BinData::Rest
#read_and_return_value — BinData::Stringz
#read_and_return_value — BinData::String
#read_and_return_value — BinData::Primitive
#read_and_return_value — BinData::BasePrimitive
#read_and_return_value — BinData::SkipUntilValidPlugin
#read_and_return_value — BinData::BitAligned
#read_and_return_value — BinData::Skip
#read_big_endian_bits — BinData::IO::Read
#read_little_endian_bits — BinData::IO::Read
#read_now! — BinData::DelayedIO
#read_raw — BinData::IO::Common::UnSeekableStream
#read_raw — BinData::IO::Common::SeekableStream
#read_raw_with_readahead — BinData::IO::Common::UnSeekableStream
#readbits — BinData::IO::Read
#readbytes — BinData::IO::Read
#readbytes — BinData::BitAligned::BitAlignedIO
#reading? — BinData::Base
#recursively_eval — BinData::LazyEvaluator
#register — BinData::Registry
#register_dynamic_class — BinData::Registry
#registered? — BinData::Registry
#rel_offset — BinData::DelayedIO
#rel_offset — BinData::Base
#remember_current_selection — BinData::CopyOnChangePlugin
#rename_parameter — BinData::SanitizedParameters
#reset_read_bits — BinData::IO::Read
#resolve_symbol_in_parent_context — BinData::LazyEvaluator
#sanitize — BinData::SanitizedParameters
#sanitize! — BinData::SanitizedParameters
#sanitize_choices — BinData::SanitizedParameters
#sanitize_endian — BinData::StructArgProcessor
#sanitize_endian — BinData::SanitizedParameters
#sanitize_fields — BinData::StructArgProcessor
#sanitize_fields — BinData::SanitizedParameters
#sanitize_hide — BinData::StructArgProcessor
#sanitize_object_prototype — BinData::SanitizedParameters
#sanitize_parameters! — BinData::StringArgProcessor
#sanitize_parameters! — BinData::PrimitiveArgProcessor
#sanitize_parameters! — BinData::RecordArgProcessor
#sanitize_parameters! — BinData::StructArgProcessor
#sanitize_parameters! — BinData::DelayedIoArgProcessor
#sanitize_parameters! — BinData::SkipArgProcessor
#sanitize_parameters! — BinData::BaseArgProcessor
#sanitize_parameters! — BinData::BufferArgProcessor
#sanitize_search_prefix — BinData::StructArgProcessor
#sanitized_field_names — BinData::StructArgProcessor
#sanitized_pad_byte — BinData::StringArgProcessor
#search_prefix — BinData::DSLMixin::DSLParser
#seek — BinData::IO::Common
#seek_raw — BinData::IO::Common::UnSeekableStream
#seek_raw — BinData::IO::Common::SeekableStream
#seekable? — BinData::IO::Common
#seekbytes — BinData::IO::Write
#seekbytes — BinData::IO::Read
#selection — BinData::Choice
#sensible_default — BinData::Stringz
#sensible_default — BinData::Skip
#sensible_default — BinData::Uint8Array
#sensible_default — BinData::Rest
#sensible_default — BinData::String
#sensible_default — BinData::BasePrimitive
#sensible_default — BinData::CountBytesRemaining
#sensible_default — BinData::Primitive
#sensible_default — BinData::Virtual
#separate_args — BinData::MultiFieldArgSeparator
#separate_args — BinData::BaseArgProcessor
#set — BinData::Primitive
#set_endian — BinData::DSLMixin::DSLParser
#size — BinData::Array
#skip_length — BinData::SkipUntilValidPlugin
#skip_length — BinData::SkipLengthPlugin
#skip_length — BinData::SkipToAbsOffsetPlugin
#slice — BinData::Array
#slice_index — BinData::Array
#slice_range — BinData::Array
#slice_start_length — BinData::Array
#snapshot — BinData::Framework
#snapshot — BinData::Struct
#snapshot — BinData::ResumeByteAlignment
#snapshot — BinData::String
#snapshot — BinData::DelayedIO
#snapshot — BinData::Buffer
#snapshot — BinData::Array
#snapshot — BinData::Stringz
#snapshot — BinData::BasePrimitive
#start_read — BinData::Base
#stream_init — BinData::IO::Common::UnSeekableStream
#stream_init — BinData::IO::Common::SeekableStream
#sum_num_bytes_below_index — BinData::ByteAlignPlugin
#sum_num_bytes_below_index — BinData::Struct
#sum_num_bytes_below_index — BinData::Array
#sum_num_bytes_for_all_elements — BinData::Array
#sum_num_bytes_for_all_fields — BinData::Struct
#to_ary — BinData::Array
#to_ary — BinData::DSLMixin
#to_binary_s — BinData::Base
#to_choice_params — BinData::DSLMixin::DSLParser
#to_hex — BinData::Base
#to_object_params — BinData::DSLMixin::DSLParser
#to_s — BinData::Base
#to_storage_formats — BinData::Array
#to_str — BinData::DSLMixin
#to_struct_params — BinData::DSLMixin::DSLParser
#to_syms — BinData::AcceptedParametersPlugin::AcceptedParameters
#top_level — BinData::Base
#top_level_get — BinData::Base
#top_level_set — BinData::Base
#trace_reading — BinData
#trace_selection — BinData::Choice
#trace_value — BinData::BasePrimitive
#trim_and_zero_terminate — BinData::Stringz
#trim_padding — BinData::String
#trim_to! — BinData::Stringz
#truncate_after_first_zero_byte! — BinData::Stringz
#underscore_name — BinData::Registry
#unregister — BinData::Registry
#unshift — BinData::Array
#valid_endian? — BinData::DSLMixin::DSLParser
#validate_field — BinData::DSLMixin::DSLFieldValidator
#value — BinData::BasePrimitive
#value= — BinData::BasePrimitive
#value_to_binary_string — BinData::BasePrimitive
#value_to_binary_string — BinData::Stringz
#value_to_binary_string — BinData::Rest
#value_to_binary_string — BinData::String
#value_to_binary_string — BinData::Skip
#value_to_binary_string — BinData::CountBytesRemaining
#value_to_binary_string — BinData::Uint8Array
#warn_if_name_is_already_registered — BinData::Registry
#warn_replacement_parameter — BinData::SanitizedParameters
#with_buffer — BinData::IO::Write
#with_buffer — BinData::IO::Read
#with_buffer_common — BinData::IO::Common
#with_readahead — BinData::IO::Common::UnSeekableStream
#with_readahead — BinData::IO::Common::SeekableStream
#write — BinData::IO::Write
#write — BinData::Base::AutoCallDelayedIO
#write — BinData::Base
#write_big_endian_bits — BinData::IO::Write
#write_little_endian_bits — BinData::IO::Write
#write_now! — BinData::DelayedIO
#write_raw — BinData::IO::Common::SeekableStream
#write_raw — BinData::IO::Common::UnSeekableStream
#writebits — BinData::IO::Write
#writebytes — BinData::IO::Write