SPVM::ByteList(3)

🎀 SPVM::ByteList(3) 🎀

Manual name: User Contributed Perl Documentation. Okay bestie, buckle up — this is the SPVM::ByteList page, and it's lowkey iconic.

✨ Name ✨

SPVM::ByteList — dynamic byte arrays, periodt.

💖 Description 💖

The ByteList class in SPVM has methods to manipulate dynamic byte arrays. That's the whole job, and it ate.

🌸 Usage 🌸

Okay so here's the group-chat demo of how you actually use it:

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. No cap.

The elements in the range that is greater than or equal to the "length" field and less than the "capacity" field are filled with 0.

🧚 Interfaces 🧚

It's giving very plugged-in, bestie:

• Cloneable
• Countable

🔥 Fields 🔥

capacity

has capacity : virtual ro int;

The capacity. This is the length of the internally reserved elements to extend the length of the list.

length

has length : virtual 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 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.

new_ref

static method new_ref : ByteList ($array : byte[]);

Creates a new ByteList object, and set the "array" field to the array $array, and return the new object.

Exceptions:

• The array $array must be defined. Otherwise an exception is thrown.

💅 Instance Methods 💅

get

method get : int ($index : int);

Gets the element of the position of $index.

If $index is a netative value, $index is set to "length" plus $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[] = undef);

Same as splice method, but the return value is not returned.

Exceptions:

• Exceptions thrown by splice method could be thrown.

splice

method splice : byte[] ($offset : int, $remove_length : int, $replace : byte[] = undef);

Replaces the elements of the range specified by $offset and $length with $replace array, and returns removed elements creating a new array.

If $replace is not defined, the replacement is not performed.

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.

If $index is a netative value, $index is set to "length" plus $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

method get_array : byte[] ();

Returns the internal "array".

unshift

method unshift : void ($element : int);

Inserts an $element at the beginning of the list.

clone

method clone : ByteList ();

Clones this instance and returns it.

push_

method push_ : void ($elements : byte[]);

Adds the elements $elements after the end of this list.

This method calls push method internally.

Exceptions:

• The elements $elements must be defined.
• Exceptions thrown by push method could be thrown.

unshift_

method unshift_ : void ($elements : byte[]);

Inserts the elements $elements at the beginning of the list.

Exceptions:

• The elements $elements must be defined.
• Exceptions thrown by unshift method could be thrown.

👑 Copyright & License 👑

Copyright (c) 2023 Yuki Kimoto

MIT License

---

That's the whole page, bestie 💖 — source/version perl v5.42.2, date 2026-02-03. Mwah! 🫶