/ 
SPVM-0.9513
River stage two • 34 direct dependents • 37 total dependents
/ SPVM::ByteList

NAME

SPVM::ByteList - Dynamic Byte Array

SYNOPSYS

use ByteList;

# Create a byte list with array
my $byte_list = ByteList->new([(byte)1, 2, 3]);

# Create a byte list with array length
my $byte_list = ByteList->new_len(10);

# Get list length
my $length = $byte_list->length;

# Push byte value
$byte_list->push((byte)3);

# Pop byte value.
my $byte_value = $byte_list->pop;

# Unshift byte value.
$byte_list->unshift((byte)3);

# Shift byte value.
my $byte_value = $byte_list->shift;

# Set byte value.
$byte_list->set(2, (byte)3);

# Get byte value.
my $byte_value = $byte_list->get(2);

# Insert byte value
$byte_list->insert(1, 3);

# Remove byte value
my $byte_value = $byte_list->remove(1);

# Convert ByteList to byte array.
my $byte_array = $byte_list->to_array;

DESCRIPTION

ByteList is Dynamic Byte Array.

CLASS METHODS

new

static method new : ByteList ($array : byte[])

Create a new ByteList object with byte array.

Internally, new array is created, and each element of argument array is copied to internal array.

If array is undef, 0-length internal array is created.

new_len

static method new_len : ByteList ($length : int)

Create a new ByteList object with array length.

INSTANCE METHODS

get

method get : byte ($index : int)

Get the value with index.

insert

method insert : void ($index : int, $value : byte)

Insert a element to the specific index.

length

static method length : int ()

Get list length.

remove

method remove : byte ($index : int)

Remove and return the element which is specified by the index.

set

method set : void ($index : int, $value : byte)

Set the value with index.

set_array

method set_array : void ($array : byte[])

Set a array. Each elements of the array is copied to the correspoinding index of the array this list has.

Array must be defined, otherwise a exception occurs.

The length of argument array must be same as the length of current list array, otherwise a exception occures.

pop

method pop : byte ()

Pops and returns the last value of the list, shortening the array by one element If there are no elements in the list, exception occur.

push

method push : void ($value : byte)

Appending the value to the end of list.

resize

method resize : void ($new_length : int)

Resize this list. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is shorter than the current length, the list is truncated to the new length. If the new length is same as the current length, there is nothing to do. If the new length is longer than the current length, the list grows to the new length, and the values of the added elements are set to 0.

New length must be more than or equals to 0, otherwise a exception occur.

shift

method shift : byte ()

Shifts the first value of the list off and returns it, shortening the array by 1 and moving everything down. If there are no elements in the list, exception occur.

to_array

method to_array : byte[] ()

Convert ByteList to byte array.

unshift

method unshift : void ($value : byte)

Appending the value to the top of list.