API Docs for: 0.0.57
Show:

BinaryStream Class

a BinaryStream can be use to perform sequential read or write inside a buffer. The BinaryStream maintains a cursor up to date as the caller operates on the stream using the various read/write methods. It uses the Little Endian convention.

data can either be:

  • a Buffer , in this case the BinaryStream operates on this Buffer
  • null , in this case a BinaryStream with 1024 bytes is created
  • any data , in this case the object is converted into a binary buffer.

example:

var stream = new BinaryStream(32)

Constructor

BinaryStream

(
  • data
)

Parameters:

  • data Null | Buffer | Number

Methods

BinaryStream.rewind

()

set the cursor to the begining of the stream

Returns:

null

readByte

() Number

read a single signed byte (8 bits) from the stream.

Returns:

Number:

readByteStream

() Buffer

read a byte stream to the stream. The method reads the length of the byte array from the stream as a 32 bits integer before reading the byte stream.

Returns:

Buffer:

readDouble

() Number

read a single 64-bit floating point number from the stream.

Returns:

Number:

the value read from the stream

readFloat

() Number

read a single 32-bit floating point number from the stream.

Returns:

Number:

the value read from the stream

readInt16

() Number

read a single signed 16-bit integer from the stream.

Returns:

Number:

readInteger

() Number

read a single signed 32-bit integer from the stream.

Returns:

Number:

readUInt16

() Number

read a single unsigned 16-bit integer from the stream.

Returns:

Number:

q

readUInt32

() Number

read a single unsigned 32-bit integer from the stream.

Returns:

Number:

the value read from the stream

readUInt8

() Number

read a single unsigned byte (8 bits) from the stream.

Returns:

Number:

writeByteStream

(
  • buf
)

write a byte stream to the stream. The method writes the length of the byte array into the stream as a 32 bits integer before the byte stream.

Parameters:

  • buf Buffer

    the buffer to write. the buffer buf.length the buffer to write

writeDouble

(
  • value
)

write a single 64 bit floating number to the stream.

Parameters:

  • value Object

writeFloat

(
  • value
)

write a single 32 bit floating number to the stream.

Parameters:

  • value Number

writeInt16

(
  • value
)

write a single 16 bit signed integer to the stream.

Parameters:

  • value Number

writeInt8

(
  • value
)

write a single signed byte (8 bits) to the stream. value must be in the range of [-127,128]

Parameters:

  • value Number

writeInteger

(
  • value
)

write a single 32 bit signed integer to the stream.

Parameters:

  • value Number

writeUInt16

(
  • value
)

write a single 16 bit unsigned integer to the stream.

Parameters:

  • value Number

writeUInt32

(
  • value
)

write a single 32 bit unsigned integer to the stream.

Parameters:

  • value Number

writeUInt8

(
  • value
)

write a single unsigned byte (8 bits) to the stream.

Parameters:

  • value Number