Name
SPVM::ByteList - Dynamic byte Arrays
Description
The ByteList class in SPVM has methods to manipulate dynamic byte arrays.
Usage
use ByteList;
# Create a byte list
my $list = ByteList->new;
my $list = ByteList->new([(byte)1, 2, 3]);
# Create a byte list with array length
my $list = ByteList->new_len(10);
# Get list length
my $length = $list->length;
# Push value
$list->push(3);
# Pop value.
my $element = $list->pop;
# Unshift value.
$list->unshift(3);
# Shift value.
my $element = $list->shift;
# Set value.
$list->set(2, 3);
# Get value.
my $element = $list->get(2);
# Insert value
$list->insert(1, 3);
# Remove value
my $element = $list->remove(1);
# Convert list to array.
my $array = $list->to_array;Details
Internal Data Structure
The "array" stored in a ByteList object always starts at index 0.
The elements in the range that is greater than or equal to "length" field and less than "capacity" field are filled with 0.
Fields
capacity
has capacity : ro int;
The capacity. This is the length of the internally reserved elements to extend the length of the list.
length
has length : ro int;
The length of the list.
array
has array : byte[];
The internal array stored in the ByteList object.
Class Methods
new
static method new : ByteList ($array : byte[] = undef, $capacity : int = -1);
Creates a new ByteList object using "new_len".
The passed length to "new_len" is the length of $array. If the array is undef, the length is 0.
The elements of $array are copied to the elements of the the created array.
Examples:
my $list = ByteList->new;
my $list = ByteList->new([(byte)1, 2, 3]);new_len
static method new_len : ByteList ($length : int, $capacity : int = -1);
Creates a new ByteList object with $length and $capacity.
If $capacity is less than 0, the capacity is set to the default value.
If $length is greater than $capacity, $capacity is set to $length.
Exceptions:
$length must be greater than or equal to 0. Otherwise an exception is thrown.
Instance Methods
get
method get : int ($index : int);
Gets the element of the position of $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list. Otherwise an exception is thrown.
insert
method insert : void ($index : int, $element : int);
Inserts an $element to the position of $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than or equal to the length of $list. Otherwise an exception is thrown.
pop
method pop : int ();
Removes the last element and return it.
Exceptions:
The length of $list must be greater than 0. Otherwise an exception is thrown.
push
method push : void ($element : int);
Adds an $element after the end of the list.
remove
method remove : int ($index : int);
Removes the element at the position of $index and return it.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list. Otherwise an exception is thrown.
replace
method replace : void ($offset : int, $remove_length : int, $replace : byte[]);
Replaces the elements of the range specified by $offset and $length with $replace array.
Exceptions:
$offset must be greater than or equal to 0. Otherwise an exception is thrown.
$remove_length must be greater than or equal to 0. Otherwise an exception is thrown.
$offset + $removing length must be less than or equal to the length of $list. Otherwise an exception is thrown.
reserve
method reserve : void ($new_capacity : int);
Reserves the elements with $new_capacity.
If $new_capacity is greater than the capacity of the list, the capacity of the list is extended to $new_capacity.
Exceptions:
$new_capacity must be greater than or equal to 0. Otherwise an exception is thrown.
resize
method resize : void ($new_length : int);
Resizes the list with $new_length.
Exceptions:
$new_length must be greater than or equal to 0. Otherwise an exception is thrown.
set
method set : void ($index : int, $element : int);
Sets $element at the position of $index.
Exceptions:
$index must be greater than or equal to 0. Otherwise an exception is thrown.
$index must be less than the length of $list.
shift
method shift : int ();
Removes the first element and return it.
Exceptions:
The length of $list must be greater than 0. Otherwise an exception is thrown.
to_array
method to_array : byte[] ();
Creates a new array with the length of the list and copies all elements of the list into the new array, and returns it.
get_array_unsafe
method get_array_unsafe : byte[] ();
Gets the internally array.
This array is unsafe because it continues to point to the old array if the internal array is extended.
unshift
method unshift : void ($element : int);
Inserts an $element at the beginning of the list.
Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License