PoolByteArray

A pooled Array of bytes.

Description

An Array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference.

Methods

Method Descriptions

• PoolByteArray PoolByteArray ( Array from )

Constructs a new PoolByteArray. Optionally, you can pass in a generic Array that will be converted.

• void append ( int byte )

Appends an element at the end of the array (alias of push_back).

• void append_array ( PoolByteArray array )

Appends a PoolByteArray at the end of this array.

• PoolByteArray compress ( int compression_mode=0 )

Returns a new PoolByteArray with the data compressed. Set the compression mode using one of CompressionMode‘s constants.

• PoolByteArray decompress ( int buffer_size, int compression_mode=0 )

Returns a new PoolByteArray with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of CompressionMode‘s constants.

• PoolByteArray decompress_dynamic ( int max_output_size, int compression_mode=0 )

Returns a new PoolByteArray with the data decompressed. Set the compression mode using one of CompressionMode‘s constants. This method only accepts gzip and deflate compression modes.

This method is potentially slower than decompress, as it may have to re-allocate it’s output buffer multiple times while decompressing, where as decompress knows it’s output buffer size from the begining.

GZIP has a maximal compression ratio of 1032:1, meaning it’s very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via max_output_size. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that ammount in bytes, then an error will be returned.

• bool empty ( )

Returns true if the array is empty.

• String get_string_from_ascii ( )

Returns a copy of the array’s contents as String. Fast alternative to get_string_from_utf8 if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use get_string_from_utf8.

• String get_string_from_utf8 ( )

Returns a copy of the array’s contents as String. Slower than get_string_from_ascii but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred.

• String hex_encode ( )

Returns a hexadecimal representation of this array as a String.

var array = PoolByteArray([11, 46, 255])
print(array.hex_encode()) # Prints: 0b2eff

• int insert ( int idx, int byte )

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

• void invert ( )

Reverses the order of the elements in the array.

• void push_back ( int byte )

Appends an element at the end of the array.

• void remove ( int idx )

Removes an element from the array by index.

• void resize ( int idx )

Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.

Note: Added elements are not automatically initialized to 0 and will contain garbage, i.e. indeterminate values.

• void set ( int idx, int byte )

Changes the byte at the given index.

• int size ( )

Returns the size of the array.

• PoolByteArray subarray ( int from, int to )

Returns the slice of the PoolByteArray between indices (inclusive) as a new PoolByteArray. Any negative index is considered to be from the end of the array.