Bytes

Utilities for working with byte sequences.

1

import Bytes from "bytes"

Values

Functions for working with the Bytes data type.

Bytes.make

1

make : Number -> Bytes

Creates a new byte sequence of the input size.

Parameters:

Returns:

Bytes.empty

1

empty : Bytes

An empty byte sequence.

Bytes.fromString

1

fromString : String -> Bytes

Creates a new byte sequence from the input string.

Parameters:

Returns:

Bytes.toString

1

toString : Bytes -> String

Creates a new string from the input bytes.

Parameters:

Returns:

Bytes.length

1

length : Bytes -> Number

Returns the length of a byte sequence.

Parameters:

Returns:

Bytes.copy

1

copy : Bytes -> Bytes

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

Parameters:

Returns:

Bytes.slice

1

slice : (Number, Number, 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

Bytes.resize

1

resize : (Number, Number, 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

Bytes.move

1

move : (Number, Number, Number, Bytes, 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

Bytes.concat

1

concat : (Bytes, Bytes) -> Bytes

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

Parameters:

Returns:

Bytes.fill

1

fill : (Int32, Bytes) -> Void

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

Parameters:

Bytes.clear

1

clear : Bytes -> Void

Replaces all bytes in a byte sequence with zeroes.

Parameters:

Binary operations on integers

Functions for encoding and decoding integers stored in a byte sequence.

Bytes.getInt8S

1

getInt8S : (Number, Bytes) -> Int32

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

Bytes.getInt8U

1

getInt8U : (Number, Bytes) -> Int32

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

Bytes.setInt8

1

setInt8 : (Number, Int32, 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

Bytes.getInt16S

1

getInt16S : (Number, Bytes) -> Int32

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

Bytes.getInt16U

1

getInt16U : (Number, Bytes) -> Int32

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

Bytes.setInt16

1

setInt16 : (Number, Int32, 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

Bytes.getInt32

1

getInt32 : (Number, 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

Bytes.setInt32

1

setInt32 : (Number, Int32, 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

Bytes.getFloat32

1

getFloat32 : (Number, 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

Bytes.setFloat32

1

setFloat32 : (Number, Float32, 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

Bytes.getInt64

1

getInt64 : (Number, 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

Bytes.setInt64

1

setInt64 : (Number, Int64, 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

Bytes.getFloat64

1

getFloat64 : (Number, 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

Bytes.setFloat64

1

setFloat64 : (Number, Float64, 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