PoolByteArray

PoolByteArray

Category: Built-In Types

Brief Description

A pooled Array of bytes.

Methods

PoolByteArray	PoolByteArray ( Array from )
void	append ( int byte )
void	append_array ( PoolByteArray array )
PoolByteArray	compress ( int compression_mode=0 )
PoolByteArray	decompress ( int buffer_size, int compression_mode=0 )
String	get_string_from_ascii ( )
String	get_string_from_utf8 ( )
int	insert ( int idx, int byte )
void	invert ( )
void	push_back ( int byte )
void	remove ( int idx )
void	resize ( int idx )
void	set ( int idx, int byte )
int	size ( )
PoolByteArray	subarray ( int from, int to )

Description

An Array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference.

Method Descriptions

PoolByteArray PoolByteArray ( Array from )

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

void append ( int byte )

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

void append_array ( PoolByteArray array )

Append 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.

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.

int insert ( int idx, int byte )

Insert 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 ( )

Reverse the order of the elements in the array.

void push_back ( int byte )

Append an element at the end of the array.

void remove ( int idx )

Remove an element from the array by index.

void resize ( int idx )

Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size.

void set ( int idx, int byte )

Change 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.