Buffer

Utilities for working with buffers.

Buffers are data structures that automatically expand as more data is appended. They are useful for storing and operating on an unknown number of bytes. All set or append operations mutate the buffer.

1

import Buffer from "buffer"

Values

Functions for working with the Buffer data type.

Buffer.make

1

make : Number -> Buffer

Creates a fresh buffer, initially empty.

The initialSize parameter is the initial size of the internal byte sequence that holds the buffer contents. That byte sequence is automatically reallocated when more than initialSize bytes are stored in the buffer, but shrinks back to initialSize characters when reset is called.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When the initialSize is a negative number

Buffer.length

1

length : Buffer -> Number

Gets the number of bytes currently contained in a buffer.

Parameters:

Returns:

Buffer.clear

1

clear : Buffer -> Void

Clears data in the buffer and sets its length to zero.

This operation does not resize the underlying byte sequence.

Parameters:

Buffer.reset

1

reset : Buffer -> Void

Empty a buffer and deallocate the internal byte sequence holding the buffer contents.

This operation resizes the underlying byte sequence to the initial size of the buffer.

Parameters:

Buffer.truncate

1

truncate : (Number, Buffer) -> Void

Shortens a buffer to the given length.

This operation does not resize the underlying byte sequence.

Parameters:

Throws:

IndexOutOfBounds

• When the length is negative
• When the length is greater than the buffer size

Buffer.toBytes

1

toBytes : Buffer -> Bytes

Returns a copy of the current contents of the buffer as a byte sequence.

Parameters:

Returns:

Buffer.toBytesSlice

1

toBytesSlice : (Number, Number, Buffer) -> Bytes

Returns a slice of the current contents of the buffer as a byte sequence.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When start is negative
• When start is greater than or equal to the buffer size
• When start + length is greater than the buffer size

Buffer.toString

1

toString : Buffer -> String

Returns a copy of the current contents of the buffer as a string.

Parameters:

Returns:

Buffer.toStringSlice

1

toStringSlice : (Number, Number, Buffer) -> String

Returns a copy of a subset of the current contents of the buffer as a string.

Parameters:

Returns:

Buffer.addBytes

1

addBytes : (Bytes, Buffer) -> Void

Appends a byte sequence to a buffer.

Parameters:

Buffer.addString

1

addString : (String, Buffer) -> Void

Appends the bytes of a string to a buffer.

Parameters:

Buffer.addChar

1

addChar : (Char, Buffer) -> Void

Appends the bytes of a char to a buffer.

Parameters:

Buffer.addStringSlice

1

addStringSlice : (Number, Number, String, Buffer) -> Void

Appends the bytes of a subset of a string to a buffer.

Parameters:

Buffer.addBytesSlice

1

addBytesSlice : (Number, Number, Bytes, Buffer) -> Void

Appends the bytes of a subset of a byte sequence to a buffer.

Parameters:

Throws:

IndexOutOfBounds

• When the start is negative
• When the start is greater than or equal to the bytes size
• When the length is negative
• When the length is greater than the bytes length minus start

Buffer.addBuffer

1

addBuffer : (Buffer, Buffer) -> Void

Appends the bytes of a source buffer to destination buffer.

The source buffer is not mutated by this operation. The destination buffer, however, is mutated.

Parameters:

Buffer.addBufferSlice

1

addBufferSlice : (Number, Number, Buffer, Buffer) -> Void

Appends the bytes of a part of a buffer to the end of the buffer

The source buffer is not mutated by this operation. The destination buffer, however, is mutated.

Parameters:

Binary operations on integers

Functions for encoding and decoding integers stored in a buffer.

Buffer.getInt8S

1

getInt8S : (Number, Buffer) -> Int32

Gets a signed 8-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 1 is greater than the buffer size

Buffer.getInt8U

1

getInt8U : (Number, Buffer) -> Int32

Gets an unsigned 8-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 1 is greater than the buffer size

Buffer.setInt8

1

setInt8 : (Number, Int32, Buffer) -> Void

Sets a signed 8-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 1 is greater than the buffer size

Buffer.addInt8

1

addInt8 : (Int32, Buffer) -> Void

Appends a signed 8-bit integer to a buffer.

Parameters:

Buffer.getInt16S

1

getInt16S : (Number, Buffer) -> Int32

Gets a signed 16-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 2 is greater than the buffer size

Buffer.getInt16U

1

getInt16U : (Number, Buffer) -> Int32

Gets an unsigned 16-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 2 is greater than the buffer size

Buffer.setInt16

1

setInt16 : (Number, Int32, Buffer) -> Void

Sets a signed 16-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 2 is greater than the buffer size

Buffer.addInt16

1

addInt16 : (Int32, Buffer) -> Void

Appends a signed 16-bit integer to a buffer.

Parameters:

Buffer.getInt32

1

getInt32 : (Number, Buffer) -> Int32

Gets a signed 32-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 4 is greater than the buffer size

Buffer.setInt32

1

setInt32 : (Number, Int32, Buffer) -> Void

Sets a signed 32-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 4 is greater than the buffer size

Buffer.addInt32

1

addInt32 : (Int32, Buffer) -> Void

Appends a signed 32-bit integer to a buffer.

Parameters:

Buffer.getFloat32

1

getFloat32 : (Number, Buffer) -> Float32

Gets a 32-bit float starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 4 is greater than the buffer size

Buffer.setFloat32

1

setFloat32 : (Number, Float32, Buffer) -> Void

Sets a 32-bit float starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 4 is greater than the buffer size

Buffer.addFloat32

1

addFloat32 : (Float32, Buffer) -> Void

Appends a 32-bit float to a buffer.

Parameters:

Buffer.getInt64

1

getInt64 : (Number, Buffer) -> Int64

Gets a signed 64-bit integer starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 8 is greater than the buffer size

Buffer.setInt64

1

setInt64 : (Number, Int64, Buffer) -> Void

Sets a signed 64-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 8 is greater than the buffer size

Buffer.addInt64

1

addInt64 : (Int64, Buffer) -> Void

Appends a signed 64-bit integer to a buffer.

Parameters:

Buffer.getFloat64

1

getFloat64 : (Number, Buffer) -> Float64

Gets a 64-bit float starting at the given byte index.

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 8 is greater than the buffer size

Buffer.setFloat64

1

setFloat64 : (Number, Float64, Buffer) -> Void

Sets a 64-bit float starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index is greater than or equal to the buffer size
• When index + 8 is greater than the buffer size

Buffer.addFloat64

1

addFloat64 : (Float64, Buffer) -> Void

Appends a 64-bit float to a buffer.

Parameters: