Name

SPVM::ByteList - Dynamic byte Array

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((byte)3);
  
  # Pop value.
  my $value = $list->pop;
  
  # Unshift value.
  $list->unshift((byte)3);
  
  # Shift value.
  my $value = $list->shift;
  
  # Set value.
  $list->set(2, (byte)3);
  
  # Get value.
  my $value = $list->get(2);
  
  # Insert value
  $list->insert(1, 3);
  
  # Remove value
  my $value = $list->remove(1);
  
  # Convert list to array.
  my $array = $list->to_array;
  

Description

ByteList is a dynamic byte array.

Fields

length

  has length : ro int;

The length.

values

  has values : ro byte[];

The values. This is the internally used array, but it can be manipulated directly.

  my $values = $list->values;
  $valeus->[0] = 5;

Class Methods

new

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

Create a new ByteList object with a byte array.

Internally, a new array is created, and each element of the specified array is copied to the new array.

If the array is undef, a new array that length is 0 is created.

Examples:

  my $list = ByteList->new;
  my $list = ByteList->new([(byte)1, 2, 3]);
  my $list = ByteList->new(undef);

new_len

  static method new_len : ByteList ($length : int)

Create a new ByteList object with the length.

The length must be greater than or equal to 0. Otherwise an excpetion will be thrown.

Instance Methods

get

  method get : byte ($index : int)

Get the element of the position of the index.

The index must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

insert

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

Insert an element to the position of the index.

The index must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The index must be less than or equal to the length of the list. Otherwise an excpetion will be thrown.

pop

  method pop : byte ()

Remove the last element and return it.

The length of the list must be greater than 0. Otherwise an excpetion will be thrown.

push

  method push : void ($value : byte)

Add an element after the end of the list.

remove

  method remove : byte ($index : int)

Remove the element at the position of the index and return it.

The index must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

replace

  method replace : void ($offset : int, $remove_length : int, $replace : byte[])

Replace the elements of the range specified by the offset and the lenght with the replacement array.

The offset must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The removing length must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The offset + the removing lenght must be less than or equal to the length of the list. Otherwise an excpetion will be thrown.

resize

  method resize : void ($new_length : int)

Resize the list.

The new length must be greater than or equal to 0. Otherwise an excpetion will be thrown.

set

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

Set the element at the position of the index.

The index must be greater than or equal to 0. Otherwise an excpetion will be thrown.

The index must be less than the length of the list. Otherwise an excpetion will be thrown.

set_array

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

Set a array. Each element of the array is copied to the element of the list.

The array must be defined. Otherwise an excpetion will be thrown.

The length of the array must be the same as the length of the list. Otherwise an excpetion will be thrown.

shift

  method shift : byte ()

Remove the first element and return it.

The length of the list must be greater than 0. Otherwise an excpetion will be thrown.

to_array

  method to_array : byte[] ()

Convert the list to an array.

unshift

  method unshift : void ($value : byte)

Insert an element at the beginning of the list.

cpanm SPVM

perl -MCPAN -e shell
install SPVM