• Name
• Usage
• Description
• Enumerations
  • DEFAULT_CAPACITY
• Fields
  • capacity
  • length
• Class Methods
  • new
  • new_len
• Instance Methods
  • push
  • push_char
  • replace
  • reserve
  • to_string
  • get_string_unsafe
• Copyright & License

Name

SPVM::StringBuffer - String Buffer

Usage

  use StringBuffer;
  
  # new
  my $buffer = StringBuffer->new;
  
  # push string
  $buffer->push("abc");
  $buffer->push("def");
  
  # Convert to string - abcdef
  my $string = $buffer->to_string;
  

Description

String buffer.

Enumerations

  enum {
    DEFAULT_CAPACITY = 4,
  }

DEFAULT_CAPACITY

The default capacity. The value is 4.

Fields

capacity

  has capacity : ro int;

The capacity. This is the length of the internally reserved characters to extend the length of the string buffer.

length

  has length : ro int;

The length of the string buffer.

Class Methods

new

static method new : StringBuffer ($string : string = undef, $capacity : int = -1);

Creates a new StringBuffer object using "new_len".

The passed $length to "new_len" is the length of $string. If the string is undef, it is 0.

$string is copied to the value of the the created string buffer.

new_len

static method new_len : StringBuffer ($length : int, $capacity : int = -1);

Creates a new StringBuffer object with $length and $capacity.

If $capacity is less than 0, $capacity is set to the value of "DEFAULT_CAPACITY".

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

push

method push : void ($string : string, $offset : int = 0, $length : int = -1);

Adds a $string from $offset to the position proceeded by $length after the end of the string in the string buffer.

Exceptions:

$string must be defined. Otherwise an exception is thrown.

$offset must be greater than or equal to 0. Otherwise an exception is thrown.

$offset + $length must be less than or equal to the length of $string. Otherwise an exception is thrown.

push_char

method push_char : void ($char : int);

Adds Ascii $char after the end of the string in the string buffer.

replace

method replace : void ($offset : int, $length : int, $replace : string);

Replace the characters of the range specified by $offset and $length in the buffer with $replace string.

Exceptions:

$offset must be greater than or equal to 0. Otherwise an exception is thrown.

$offset + $length must be less than or equal to the length of the string buffer. Otherwise an exception is thrown.

reserve

method reserve : void ($new_capacity : int);

Reserves the characters that size is $new_capacity.

If $new_capacity is greater than the capacity of the string buffer, the capacity of the string buffer is extended to $new_capacity.

Exceptions:

$new_capacity must be greater than or equal to 0. Otherwise an exception is thrown.

to_string

method to_string : string ();

Creates a new string with the length of the buffer and copies all characters in the buffer into the new string, and returns it.

get_string_unsafe

method get_string_unsafe : string ();

Gets the internally string.

This buffer is unsafe because it continues to point to the old string if the internal string is extended.

Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License

cpanm SPVM

perl -MCPAN -e shell
install SPVM