Module: BinData::CheckOrAdjustOffsetPlugin
- Included in:
- Base
- Defined in:
- lib/bindata/offset.rb
Overview
Parameters
Parameters may be provided at initialisation to control the behaviour of an object. These parameters are:
:check_offset
-
Raise an error if the current IO offset doesn’t meet this criteria. A boolean return indicates success or failure. Any other return is compared to the current offset. The variable
offset
is made available to any lambda assigned to this parameter. This parameter is only checked before reading. :adjust_offset
-
Ensures that the current IO offset is at this position before reading. This is like
:check_offset
, except that it will adjust the IO offset instead of raising an error.
Defined Under Namespace
Modules: AdjustOffsetMixin, CheckOffsetMixin
Class Method Summary collapse
-
.included(base) ⇒ Object
:nodoc:.
Instance Method Summary collapse
Class Method Details
.included(base) ⇒ Object
:nodoc:
20 21 22 23 |
# File 'lib/bindata/offset.rb', line 20 def self.included(base) #:nodoc: base.optional_parameters :check_offset, :adjust_offset base.mutually_exclusive_parameters :check_offset, :adjust_offset end |
Instance Method Details
#initialize_shared_instance ⇒ Object
25 26 27 28 29 |
# File 'lib/bindata/offset.rb', line 25 def initialize_shared_instance extend CheckOffsetMixin if has_parameter?(:check_offset) extend AdjustOffsetMixin if has_parameter?(:adjust_offset) super end |