Table of Contents - bindata-2.4.0 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::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::Framework
BinData::IO
BinData::IO::Common
BinData::IO::Common::SeekableStream
BinData::IO::Common::UnSeekableStream
BinData::IO::Read
BinData::IO::Write
BinData::InitialLengthPlugin
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
BinData::StructArgProcessor
BinData::Uint8
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::BasePrimitive
::bit_aligned — BinData::Primitive
::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
::make_class_abstract — BinData::DSLMixin::DSLBigAndLittleEndianHandler
::new — BinData::AcceptedParametersPlugin::AcceptedParameters
::new — BinData::SanitizedParameters
::new — BinData::IO::Write
::new — BinData::LazyEvaluator
::new — BinData::SanitizedFields
::new — BinData::Registry
::new — BinData::DSLMixin::DSLParser
::new — BinData::IO::Read
::new — BinData::DSLMixin::DSLFieldValidator
::new — BinData::SanitizedChoices
::new — BinData::SanitizedField
::new — BinData::DSLMixin::DSLFieldParser
::new — BinData::SanitizedPrototype
::new — BinData::Base
::new — BinData::BitAligned::BitAlignedIO
::new — BinData::IO::Common
::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::BasePrimitive
::turn_off_tracing — BinData::Choice
::turn_on_tracing — BinData::Choice
::turn_on_tracing — BinData::BasePrimitive
#<< — BinData::Array
#<=> — BinData::BasePrimitive
#=~ — BinData::Base
#[] — BinData::SanitizedChoices
#[] — BinData::SanitizedFields
#[] — BinData::Array
#[] — BinData::Struct
#[]= — BinData::Struct
#[]= — BinData::Array
#_value — BinData::BasePrimitive::InitialValuePlugin
#_value — BinData::BasePrimitive::ValuePlugin
#_value — BinData::BasePrimitive::AssertedValuePlugin
#abs_offset — BinData::DelayedIO
#abs_offset — BinData::Base
#abs_offset= — BinData::DelayedIO
#add_field — BinData::SanitizedFields
#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
#assert! — BinData::BasePrimitive::AssertPlugin
#assert! — BinData::BasePrimitive::AssertedValuePlugin
#assert_value — BinData::BasePrimitive::AssertedValuePlugin
#assign — BinData::DelayedIO
#assign — BinData::Primitive
#assign — BinData::Framework
#assign — BinData::Array
#assign — BinData::Struct
#assign — BinData::Buffer
#assign — BinData::Stringz
#assign — BinData::BasePrimitive
#assign — BinData::BasePrimitive::AssertedValuePlugin
#assign — BinData::BasePrimitive::ValuePlugin
#assign — BinData::BasePrimitive::AssertPlugin
#assign — BinData::ResumeByteAlignment
#assign — BinData::String
#at — BinData::Array
#bit_aligned? — BinData::BitAligned
#bit_aligned? — BinData::Framework
#bytes_to_align — BinData::ByteAlignPlugin
#clear — BinData::Base
#clear? — BinData::ResumeByteAlignment
#clear? — BinData::Buffer
#clear? — BinData::DelayedIO
#clear? — BinData::Framework
#clear? — BinData::Array
#concat — BinData::Array
#const_missing — BinData::BitFieldFactory
#const_missing — BinData::IntFactory
#copy_previous_value — BinData::CopyOnChangePlugin
#create_sanitized_params — BinData::SanitizedParameters
#current_choice — BinData::CopyOnChangePlugin
#debug_name — BinData::Base
#default — BinData::AcceptedParametersPlugin::AcceptedParameters
#default_parameter — BinData::AcceptedParametersPlugin
#default_parameters — BinData::AcceptedParametersPlugin
#do_num_bytes — BinData::ResumeByteAlignment
#do_num_bytes — BinData::BitAligned
#do_num_bytes — BinData::Virtual
#do_num_bytes — BinData::Primitive
#do_read — BinData::ReadUntilEOFPlugin
#do_read — BinData::InitialLengthPlugin
#do_read — BinData::ReadUntilPlugin
#do_read — BinData::Virtual
#do_read — BinData::ByteAlignPlugin
#do_read — BinData::ResumeByteAlignment
#do_read_with_hook — BinData::Choice
#do_read_with_hook — BinData::BasePrimitive
#do_write — BinData::Virtual
#do_write — BinData::BitAligned
#do_write — BinData::ByteAlignPlugin
#do_write — BinData::Struct
#do_write — BinData::ResumeByteAlignment
#do_write — BinData::Primitive
#dsl_params — BinData::DSLMixin::DSLParser
#dsl_parser — BinData::DSLMixin
#duplicate_name? — BinData::DSLMixin::DSLFieldValidator
#each — BinData::Array
#each — BinData::SanitizedFields
#each_pair — BinData::Struct
#elements — BinData::InitialLengthPlugin
#empty? — BinData::SanitizedFields
#empty? — BinData::Array
#endian — BinData::DSLMixin::DSLParser
#endian — BinData::SanitizedBigEndian
#endian — BinData::SanitizedLittleEndian
#ensure_valid_name — BinData::DSLMixin::DSLFieldValidator
#eql? — BinData::BasePrimitive
#eval_parameter — 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::DSLParser
#fields — BinData::DSLMixin::DSLFieldValidator
#find_index — BinData::Array
#find_index_of — BinData::Array
#first — BinData::Array
#flush — BinData::IO::Write
#flushbits — BinData::IO::Write
#get_parameter — BinData::Base
#get_previous_choice — BinData::CopyOnChangePlugin
#has_at_least_one_of? — BinData::SanitizedParameters
#has_key? — BinData::Struct
#has_parameter? — BinData::SanitizedPrototype
#has_parameter? — BinData::Base
#has_parameter? — BinData::SanitizedField
#hash — BinData::BasePrimitive
#hide — BinData::DSLMixin::DSLParser
#hints — BinData::SanitizedParameters
#index — BinData::LazyEvaluator
#index — BinData::Array
#initialize_instance — BinData::Base
#initialize_instance — BinData::Choice
#initialize_instance — BinData::BasePrimitive
#initialize_instance — BinData::Struct
#initialize_instance — BinData::DelayedIO
#initialize_instance — BinData::Buffer
#initialize_instance — BinData::Array
#initialize_instance — BinData::Framework
#initialize_instance — BinData::Primitive
#initialize_shared_instance — BinData::Base::AutoCallDelayedIO
#initialize_shared_instance — BinData::Array
#initialize_shared_instance — BinData::RegisterNamePlugin
#initialize_shared_instance — BinData::Framework
#initialize_shared_instance — BinData::CheckOrAdjustOffsetPlugin
#initialize_shared_instance — BinData::Choice
#initialize_shared_instance — BinData::Struct
#initialize_shared_instance — BinData::Skip
#initialize_shared_instance — BinData::BasePrimitive
#initialize_shared_instance — BinData::String
#initialize_with_warning — BinData::Base
#insert — BinData::Array
#inspect — BinData::Base
#instantiate — BinData::SanitizedPrototype
#instantiate — BinData::SanitizedField
#key? — BinData::Struct
#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
#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
#new — BinData::Base
#no_field_names_blank? — BinData::SanitizedFields
#num_bytes — BinData::Base::AutoCallDelayedIO
#num_bytes — BinData::Base
#num_bytes — BinData::DelayedIO
#num_bytes_remaining — BinData::IO::Common::SeekableStream
#num_bytes_remaining — BinData::IO::Common::UnSeekableStream
#offset — BinData::IO::Write
#offset — BinData::IO::Read
#offset_raw — BinData::IO::Common::UnSeekableStream
#option? — BinData::DSLMixin::DSLFieldValidator
#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
#push — BinData::Array
#raw_fields — BinData::SanitizedFields
#raw_num_bytes — BinData::Buffer
#read — BinData::Base::AutoCallDelayedIO
#read — BinData::Base
#read_all_bytes — BinData::IO::Read
#read_and_return_value — BinData::BitAligned
#read_and_return_value — BinData::WarnNoReadLengthPlugin
#read_and_return_value — BinData::SkipUntilValidPlugin
#read_now! — BinData::DelayedIO
#readbits — BinData::IO::Read
#readbytes — BinData::BitAligned::BitAlignedIO
#readbytes — BinData::IO::Read
#register — 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
#sanitize — BinData::SanitizedParameters
#sanitize_choices — BinData::SanitizedParameters
#sanitize_endian — BinData::SanitizedParameters
#sanitize_fields — BinData::SanitizedParameters
#sanitize_object_prototype — BinData::SanitizedParameters
#sanitize_parameters! — BinData::BaseArgProcessor
#sanitize_parameters! — BinData::BufferArgProcessor
#sanitize_parameters! — BinData::StructArgProcessor
#sanitize_parameters! — BinData::RecordArgProcessor
#sanitize_parameters! — BinData::SkipArgProcessor
#sanitize_parameters! — BinData::DelayedIoArgProcessor
#sanitize_parameters! — BinData::StringArgProcessor
#sanitize_parameters! — BinData::PrimitiveArgProcessor
#search_prefix — BinData::DSLMixin::DSLParser
#seekbytes — BinData::IO::Read
#seekbytes — BinData::IO::Write
#selection — BinData::Choice
#sensible_default — BinData::Virtual
#separate_args — BinData::MultiFieldArgSeparator
#separate_args — BinData::BaseArgProcessor
#size — BinData::Array
#skip_length — BinData::SkipUntilValidPlugin
#skip_length — BinData::SkipToAbsOffsetPlugin
#skip_length — BinData::SkipLengthPlugin
#slice — BinData::Array
#snapshot — BinData::String
#snapshot — BinData::Stringz
#snapshot — BinData::Buffer
#snapshot — BinData::BasePrimitive
#snapshot — BinData::ResumeByteAlignment
#snapshot — BinData::Struct
#snapshot — BinData::Framework
#snapshot — BinData::DelayedIO
#snapshot — BinData::Array
#sum_num_bytes_below_index — BinData::ByteAlignPlugin
#to_ary — BinData::Array
#to_ary — BinData::DSLMixin
#to_binary_s — BinData::Base
#to_hex — BinData::Base
#to_s — BinData::Base
#to_str — BinData::DSLMixin
#trace_selection — BinData::Choice
#trace_value — BinData::BasePrimitive
#underscore_name — BinData::Registry
#unregister — BinData::Registry
#unshift — BinData::Array
#validate_field — BinData::DSLMixin::DSLFieldValidator
#value — BinData::BasePrimitive
#value= — BinData::BasePrimitive
#warn_replacement_parameter — BinData::SanitizedParameters
#with_buffer — BinData::IO::Write
#with_buffer — BinData::IO::Read
#with_readahead — BinData::IO::Common::UnSeekableStream
#with_readahead — BinData::IO::Common::SeekableStream
#write — BinData::Base::AutoCallDelayedIO
#write — BinData::Base
#write_now! — BinData::DelayedIO
#writebits — BinData::IO::Write
#writebytes — BinData::IO::Write