Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Data::Object::Regexp::UserlContributed Perl DocData::Object::Regexp::Result(3)

NAME
       Data::Object::Regexp::Result - Regexp Result Object for Perl 5

VERSION
       version 0.59

SYNOPSIS
	   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
	   ]);

DESCRIPTION
       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.

METHODS
   captures
	   # 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.

   count
	   # 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.

   initial
	   # 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.

   last_match_end
	   # 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.

   last_match_start
	   # 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.

   matched
	   # 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.

   named_captures
	   # 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.

   postmatched
	   # 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.

   prematched
	   # 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.

   regexp
	   # 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.

   string
	   # 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.

SEE ALSO
       o   Data::Object::Array

       o   Data::Object::Class

       o   Data::Object::Class::Syntax

       o   Data::Object::Code

       o   Data::Object::Float

       o   Data::Object::Hash

       o   Data::Object::Integer

       o   Data::Object::Number

       o   Data::Object::Role

       o   Data::Object::Role::Syntax

       o   Data::Object::Regexp

       o   Data::Object::Scalar

       o   Data::Object::String

       o   Data::Object::Undef

       o   Data::Object::Universal

       o   Data::Object::Autobox

       o   Data::Object::Immutable

       o   Data::Object::Library

       o   Data::Object::Prototype

       o   Data::Object::Signatures

AUTHOR
       Al Newkirk <anewkirk@ana.io>

COPYRIGHT AND LICENSE
       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.

perl v5.24.1			  2015-11-29   Data::Object::Regexp::Result(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Data::Object::Regexp::Result&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help