Name

SPVM::Regex::ReplaceInfo - Regex Replacement Information

Description

The Regex::ReplaceInfo class of SPVM has methods to manipulate a regex replacement information.

Usage

            

              
              
use Regex::ReplaceInfo;
my $replace_info = Regex::ReplaceInfo->new({replaced_count => 3, match => $match});
my $replaced_count = $replace_info->replaced_count;
my $match = $replace_info->match;
my $cap1 = $match->cap1;
my $cap2 = $match->cap2;
my $cpa3 = $match->cap3;
            
          

Fields

replaced_count

            

              
              
has replaced_count : ro int;
            
          

Gets the replaced_count field.

This field is set to the number of strings replaced the replace and replace_g method in the Regex class.

match

            

              
              
has match : ro Regex::Match;
            
          

Gets the match field. The type is Regex::Match.

This field is set to the result of the pattern match performed by the the replace and replace_g method in the Regex class.

Class Methods

new

            

              
              
static method new : Regex::ReplaceInfo ($options : object[] = undef);
            
          

Creates a new Regex::ReplaceInfo object.

Options:

The options are key-value pairs. Each key must be a string type. Otherwise an exception is thrown.

If an unsupported option is specified, an exception is thrown.

• replaced_count

  Sets the "replaced_count" field.

  The value must be cast to the int type. Otherwise an exception is thrown.

  Default:

  0

• match

  Sets the "match" field.

  The value must be a Regex::Match object or undef. Otherwise an exception is thrown.

  Default:

  undef

Copyright & License

Copyright (c) 2023 Yuki Kimoto

MIT License