Data::Object::Regexp::Result - Regexp Result Object for Perl 5
version 0.59
use Data::Object::Regexp::Result; my $result = Data::Object::Regexp::Result->new([ $regexp, $altered_string, $count, $last_match_end, $last_match_start, $named_captures, $initial_string ]);
Data::Object::Regexp::Result provides routines for introspecting the results of an operation involving a regular expressions. These methods work on data whose shape conforms to the tuple defined in the synopsis.
# given the expression qr/(.* test)/ # given the string "example test matching" $result->captures; # ['example test']
The captures method returns the capture groups from the result object which contains information about the results of the regular expression operation.
# given the expression qr/.* test/ # given the string "example test matching" $result->count; # 1
The count method returns the number of match occurrences from the result object which contains information about the results of the regular expression operation.
# given the expression qr/.* test/ # given the string "example test matching" $result->replace($string, 'love', 'g'); $result->string; # 'love matching' $result->initial; # 'example test matching'
The initial method returns the unaltered string from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(.* test)/ # given the string "example test matching" $result->last_match_end;
The last_match_end method returns an array of offset positions into the string where the capture(s) stopped matching from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(.* test)/ # given the string "example test matching" $result->last_match_start;
The last_match_start method returns an array of offset positions into the string where the capture(s) matched from the result object which contains information about the results of the regular expression operation.
# given the expression qr/.* test/ # given the string "example test matching" $result->matched; # "example test"
The matched method returns the portion of the string that matched from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(?<stuff>.* test)/ # given the string "example test matching" $result->named_captures; # { stuff => "example test" }
The named_captures method returns a hash containing the requested named regular expressions and captured string pairs from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(.* test)/ # given the string "example test matching" $result->postmatched; # " matching"
The postmatched method returns the portion of the string after the regular expression matched from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(test .*)/ # given the string "example test matching" $result->prematched; # "example "
The prematched method returns the portion of the string before the regular expression matched from the result object which contains information about the results of the regular expression operation.
# given the expression qr/.* test/ # given the string "example test matching" $result->regexp; # qr/.* test/
The regexp method returns the regular expression used to perform the match from the result object which contains information about the results of the regular expression operation.
# given the expression qr/(.* test)/ # given the string "example test matching" $result->string; # "example test matching"
The string method returns the string matched against the regular expression from the result object which contains information about the results of the regular expression operation.
Data::Object::Array
Data::Object::Class
Data::Object::Class::Syntax
Data::Object::Code
Data::Object::Float
Data::Object::Hash
Data::Object::Integer
Data::Object::Number
Data::Object::Role
Data::Object::Role::Syntax
Data::Object::Regexp
Data::Object::Scalar
Data::Object::String
Data::Object::Undef
Data::Object::Universal
Data::Object::Autobox
Data::Object::Immutable
Data::Object::Library
Data::Object::Prototype
Data::Object::Signatures
Al Newkirk <anewkirk@ana.io>
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Data::Object, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Object
CPAN shell
perl -MCPAN -e shell install Data::Object
For more information on module installation, please visit the detailed CPAN module installation guide.