Class: BinData::IO::Write

Inherits:
Object
  • Object
show all
Includes:
Common
Defined in:
lib/bindata/io.rb

Overview

Create a new IO Write wrapper around io. io must provide #write. If io is a string it will be automatically wrapped in an StringIO object.

The IO can handle bitstreams in either big or little endian format.

See IO::Read for more information.

Instance Method Summary collapse

Constructor Details

#initialize(io) ⇒ Write

Returns a new instance of Write.



309
310
311
312
313
314
315
 
# File 'lib/bindata/io.rb', line 309

def initialize(io)
  super(io)

  @wnbits  = 0
  @wval    = 0
  @wendian = nil
end

Instance Method Details

#flushbits ⇒ Object Also known as: flush

To be called after all writebits have been applied.



365
366
367
368
369
370
371
 
# File 'lib/bindata/io.rb', line 365

def flushbits
  raise "Internal state error nbits = #{@wnbits}" if @wnbits >= 8

  if @wnbits > 0
    writebits(0, 8 - @wnbits, @wendian)
  end
end

#offset ⇒ Object

Returns the current offset of the io stream. Offset will be rounded up when writing bitfields.



330
331
332
 
# File 'lib/bindata/io.rb', line 330

def offset
  offset_raw + (@wnbits > 0 ? 1 : 0)
end

#seekbytes(n) ⇒ Object

Seek n bytes from the current position in the io stream.



335
336
337
338
 
# File 'lib/bindata/io.rb', line 335

def seekbytes(n)
  flushbits
  seek(n)
end

#with_buffer(n, &block) ⇒ Object

Sets a buffer of n bytes on the io stream. Any writes inside the block will be contained within this buffer. If less than n bytes are written inside the block, the remainder will be padded with ‘0’ bytes.



321
322
323
324
325
326
 
# File 'lib/bindata/io.rb', line 321

def with_buffer(n, &block)
  with_buffer_common(n) do |buf_start, buf_end|
    block.call
    write("\0" * (buf_end - offset))
  end
end

#writebits(val, nbits, endian) ⇒ Object

Writes nbits bits from val to the stream. endian specifies whether the bits are to be stored in :big or :little endian format.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/bindata/io.rb', line 348

def writebits(val, nbits, endian)
  if @wendian != endian
    # don't mix bits of differing endian
    flushbits
    @wendian = endian
  end

  clamped_val = val & mask(nbits)

  if endian == :big
    write_big_endian_bits(clamped_val, nbits)
  else
    write_little_endian_bits(clamped_val, nbits)
  end
end

#writebytes(str) ⇒ Object

Writes the given string of bytes to the io stream.



341
342
343
344
 
# File 'lib/bindata/io.rb', line 341

def writebytes(str)
  flushbits
  write(str)
end