Bytes

Utilities for working with byte sequences.

1

from "bytes" include Bytes

1

b"\x00"

1

Bytes.make(1)

Values

Functions and constants included in the Bytes module.

Bytes.make

1

make : (size: Number) => Bytes

Creates a new byte sequence of the input size.

Parameters:

Returns:

Examples:

1

Bytes.make(0) == b"""

1

Bytes.make(1) == b"\x00"

Bytes.empty

1

empty : Bytes

An empty byte sequence.

Examples:

1

Bytes.empty == b""

Bytes.fromString

1

fromString : (string: String) => Bytes

Creates a new byte sequence from the input string.

Parameters:

Returns:

Examples:

1

Bytes.fromString("\x00\x00") == b"\x00\x00"

Bytes.toString

1

toString : (bytes: Bytes) => String

Creates a new string from the input bytes.

Parameters:

Returns:

Examples:

1

Bytes.toString(b"\x48\x65\x6c\x6c\x6f\x20\x57\x6f\x72\x6c\x64") == "Hello World"

1

Bytes.toString(b"Hello World") == "Hello World"

Bytes.length

1

length : (bytes: Bytes) => Number

Returns the length of a byte sequence.

Parameters:

Returns:

Examples:

1

Bytes.length(b"") == 0

1

Bytes.length(b"\x48") == 1

Bytes.copy

1

copy : (bytes: Bytes) => Bytes

Creates a new byte sequence that contains the same bytes as the input byte sequence.

Parameters:

Returns:

Examples:

1

Bytes.copy(b"\x48") == b"\x48"

Bytes.slice

1

slice : (start: Number, length: Number, bytes: Bytes) => Bytes

Returns a copy of a subset of the input byte sequence.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When start + length is greater than the bytes size

Examples:

1
2
3

assert Bytes.toString(
  Bytes.slice(0, 5, b"\x48\x65\x6c\x6c\x6f\x20\x57\x6f\x72\x6c\x64")
) == "Hello"

Bytes.resize

1

resize : (left: Number, right: Number, bytes: Bytes) => Bytes

Returns a copy of a byte sequence with bytes added or removed from the beginning and/or end.

A positive number represents bytes to add, while a negative number represents bytes to remove.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When the new size is negative

Examples:

1

Bytes.length(Bytes.resize(0, 3, b"")) == 3

Bytes.move

1
2
3

move :
  (srcIndex: Number, dstIndex: Number, length: Number, src: Bytes, dst: Bytes) =>
   Void

Copies a range of bytes from a source byte sequence to a given location in a destination byte sequence.

Parameters:

Throws:

InvalidArgument(String)

• When srcIndex + length is greater than the src bytes size
• When the dstIndex + length is greater than the dst bytes size

Examples:

1
2
3

let bytes = Bytes.make(5)
Bytes.move(0, 0, 5, b"\x48\x64\x6c\x6f\x20\x57\x6f\x72\x6c\x64", bytes)
assert Bytes.toString(bytes) == "Hello"

Bytes.concat

1

concat : (bytes1: Bytes, bytes2: Bytes) => Bytes

Creates a new byte sequence that contains the bytes of both byte sequences.

Parameters:

Returns:

Examples:

1
2
3

let helloBytes = Bytes.fromString("Hello ")
let worldBytes = Bytes.fromString("World")
assert Bytes.toString(Bytes.concat(helloBytes, worldBytes)) == "Hello World"

Bytes.fill

1

fill : (value: Uint8, bytes: Bytes) => Void

Replaces all bytes in a byte sequnce with the new value provided.

Parameters:

Examples:

1
2
3

let bytes = Bytes.make(5)
Bytes.fill(1us, bytes)
assert bytes == b"\x01\x01\x01\x01\x01"

Bytes.clear

1

clear : (bytes: Bytes) => Void

Replaces all bytes in a byte sequence with zeroes.

Parameters:

Examples:

1
2
3
4

let bytes = Bytes.make(5)
Bytes.fill(1us, bytes)
Bytes.clear(bytes)
assert bytes == b"\x00\x00\x00\x00\x00"

Bytes.getInt8

1

getInt8 : (index: Number, bytes: Bytes) => Int8

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 1 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(1)
Bytes.setInt8(0, 1s, bytes)
assert Bytes.getInt8(0, bytes) == 1s

Bytes.setInt8

1

setInt8 : (index: Number, value: Int8, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 1 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(1)
Bytes.setInt8(0, 2s, bytes)
assert Bytes.getInt8(0, bytes) == 2s

Bytes.getUint8

1

getUint8 : (index: Number, bytes: Bytes) => Uint8

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 1 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(1)
Bytes.setUint8(0, 1us, bytes)
assert Bytes.getUint8(0, bytes) == 1us

Bytes.setUint8

1

setUint8 : (index: Number, value: Uint8, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 1 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(2)
Bytes.setUint8(1, 2us, bytes)
assert Bytes.getUint8(1, bytes) == 2us

Bytes.getInt16

1

getInt16 : (index: Number, bytes: Bytes) => Int16

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 2 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(2)
Bytes.setInt16(0, -2S, bytes)
assert Bytes.getInt16(0, bytes) == -2S

Bytes.setInt16

1

setInt16 : (index: Number, value: Int16, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 2 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(2)
Bytes.setInt16(0, -1S, bytes)
assert Bytes.getInt16(0, bytes) == -1S

Bytes.getUint16

1

getUint16 : (index: Number, bytes: Bytes) => Uint16

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 2 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(2)
Bytes.setUint16(0, 2uS, bytes)
assert Bytes.getUint16(0, bytes) == 2uS

Bytes.setUint16

1

setUint16 : (index: Number, value: Uint16, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 2 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(2)
Bytes.setUint16(0, 2uS, bytes)
assert Bytes.getUint16(0, bytes) == 2uS

Bytes.getInt32

1

getInt32 : (index: Number, bytes: Bytes) => Int32

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setInt32(0, 1l, bytes)
assert Bytes.getInt32(0, bytes) == 1l

Bytes.setInt32

1

setInt32 : (index: Number, value: Int32, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setInt32(0, 1l, bytes)
assert Bytes.getInt32(0, bytes) == 1l

Bytes.getUint32

1

getUint32 : (index: Number, bytes: Bytes) => Uint32

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setUint32(0, 1ul, bytes)
assert Bytes.getUint32(0, bytes) == 1ul

Bytes.setUint32

1

setUint32 : (index: Number, value: Uint32, bytes: Bytes) => Void

Sets an unsigned 32-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setUint32(0, 1ul, bytes)
assert Bytes.getUint32(0, bytes) == 1ul

Bytes.getFloat32

1

getFloat32 : (index: Number, bytes: Bytes) => Float32

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setFloat32(0, 1.0f, bytes)
assert Bytes.getFloat32(0, bytes) == 1.0f

Bytes.setFloat32

1

setFloat32 : (index: Number, value: Float32, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 4 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(4)
Bytes.setFloat32(0, 1.0f, bytes)
assert Bytes.getFloat32(0, bytes) == 1.0f

Bytes.getInt64

1

getInt64 : (index: Number, bytes: Bytes) => Int64

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setInt64(0, 1L, bytes)
assert Bytes.getInt64(0, bytes) == 1L

Bytes.setInt64

1

setInt64 : (index: Number, value: Int64, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setInt64(0, 1L, bytes)
assert Bytes.getInt64(0, bytes) == 1L

Bytes.getUint64

1

getUint64 : (index: Number, bytes: Bytes) => Uint64

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setUint64(0, 1uL, bytes)
assert Bytes.getUint64(0, bytes) == 1uL

Bytes.setUint64

1

setUint64 : (index: Number, value: Uint64, bytes: Bytes) => Void

Sets an unsigned 64-bit integer starting at the given byte index.

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setUint64(0, 1uL, bytes)
assert Bytes.getUint64(0, bytes) == 1uL

Bytes.getFloat64

1

getFloat64 : (index: Number, bytes: Bytes) => Float64

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

Parameters:

Returns:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setFloat64(0, 1.0d, bytes)
assert Bytes.getFloat64(0, bytes) == 1.0d

Bytes.setFloat64

1

setFloat64 : (index: Number, value: Float64, bytes: Bytes) => Void

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

Parameters:

Throws:

IndexOutOfBounds

• When index is negative
• When index + 8 is greater than the bytes size

Examples:

1
2
3

let bytes = Bytes.make(8)
Bytes.setFloat64(0, 1.0d, bytes)
assert Bytes.getFloat64(0, bytes) == 1.0d