Class: HexaPDF::StreamData
- Inherits:
-
Object
- Object
- HexaPDF::StreamData
- Defined in:
- lib/hexapdf/stream.rb
Overview
Container for stream data that is more complex than a string.
This helper class wraps all information necessary to read stream data by using a Fiber object (see HexaPDF::Filter). The underlying data either comes from an IO object, a file represented by its file name or a Fiber defined via a Proc object.
Additionally, the #filter and #decode_parms can be set to indicate that the data returned from the Fiber needs to be post-processed. The filter
and decode_parms
are automatically normalized to arrays on assignment to ease further processing.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#decode_parms ⇒ Object
readonly
The decoding parameters associated with the
filter
(s). -
#filter ⇒ Object
readonly
The filter(s) that need to be applied for getting the decoded stream data.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Returns whether this stream data object is equal to the other stream data object.
-
#fiber(chunk_size = 0) ⇒ Object
Returns a Fiber for getting at the data of the stream represented by this object.
-
#initialize(source = nil, offset: nil, length: nil, filter: nil, decode_parms: nil, &block) ⇒ StreamData
constructor
:call-seq: StreamData.new(io) -> stream_data StreamData.new(str) -> stream_data StreamData.new(proc) -> stream_data StreamData.new { block } -> stream_data.
Constructor Details
#initialize(source = nil, offset: nil, length: nil, filter: nil, decode_parms: nil, &block) ⇒ StreamData
:call-seq:
StreamData.new(io) -> stream_data
StreamData.new(str) -> stream_data
StreamData.new(proc) -> stream_data
StreamData.new { block } -> stream_data
Creates a new StreamData object for the given source
and with the given options.
The source
can be:
-
An IO stream which is read starting from a specific
offset
for a specificlength
-
A string which is interpreted as a file name and read starting from a specific
offset
-
and for a specific
length
-
A Proc object (that is converted to a Fiber when needed) in which case the
offset
and value is ignored. The Proc object can also be passed by using a block.
77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/hexapdf/stream.rb', line 77 def initialize(source = nil, offset: nil, length: nil, filter: nil, decode_parms: nil, &block) if source.nil? && !block_given? raise ArgumentError, "Either a source object or a block must be given" end @source = source || block @offset = offset @length = length @filter = [filter].flatten.compact @decode_parms = [decode_parms].flatten freeze end |
Instance Attribute Details
#decode_parms ⇒ Object (readonly)
The decoding parameters associated with the filter
(s).
58 59 60 |
# File 'lib/hexapdf/stream.rb', line 58 def decode_parms @decode_parms end |
#filter ⇒ Object (readonly)
The filter(s) that need to be applied for getting the decoded stream data.
55 56 57 |
# File 'lib/hexapdf/stream.rb', line 55 def filter @filter end |
Instance Method Details
#==(other) ⇒ Object
Returns whether this stream data object is equal to the other stream data object.
105 106 107 108 109 |
# File 'lib/hexapdf/stream.rb', line 105 def ==(other) other.kind_of?(StreamData) && source == other.source && offset == other.offset && length == other.length && filter == other.filter && decode_parms == other.decode_parms end |
#fiber(chunk_size = 0) ⇒ Object
Returns a Fiber for getting at the data of the stream represented by this object.
90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/hexapdf/stream.rb', line 90 def fiber(chunk_size = 0) if @source.kind_of?(FiberDoubleForString) @source.dup elsif @source.kind_of?(Proc) FiberWithLength.new(@length, &@source) elsif @source.kind_of?(String) HexaPDF::Filter.source_from_file(@source, pos: @offset || 0, length: @length || -1, chunk_size: chunk_size) else HexaPDF::Filter.source_from_io(@source, pos: @offset || 0, length: @length || -1, chunk_size: chunk_size) end end |