NAME

Data::Object::Regexp

ABSTRACT

Data-Object Regexp Class

SYNOPSIS

  use Data::Object::Regexp;

  my $re = Data::Object::Regexp->new(qr(\w+));

DESCRIPTION

This package provides routines for operating on Perl 5 regular expressions.

INHERITANCE

This package inherits behaviors from:

Data::Object::Regexp::Base

INTEGRATIONS

This package integrates behaviors from:

Data::Object::Role::Dumpable

Data::Object::Role::Functable

Data::Object::Role::Throwable

LIBRARIES

This package uses type constraints defined by:

Data::Object::Library

METHODS

This package implements the following methods.

defined

  defined() : NumObject

The defined method returns true if the object represents a value that meets the criteria for being defined, otherwise it returns false. This method returns a Data::Object::Number object.

defined example

  # given $regexp

  $re->defined; # 1

eq

  eq(Any $arg1) : NumObject

The eq method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

eq example

  # given $re

  $re->eq; # exception thrown

ge

  ge(Any $arg1) : NumObject

The ge method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

ge example

  # given $re

  $re->ge; # exception thrown

gt

  gt(Any $arg1) : NumObject

The gt method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

gt example

  # given $re

  $re->gt; # exception thrown

le

  le(Any $arg1) : NumObject

The le method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

le example

  # given $re

  $re->le; # exception thrown

lt

  lt(Any $arg1) : NumObject

The lt method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

lt example

  # given $re

  $re->lt; # exception thrown

ne

  ne(Any $arg1) : NumObject

The ne method is a consumer requirement but has no function and is not implemented. This method will throw an exception if called.

ne example

  # given $re

  $re->ne; # exception thrown

replace

  replace(Str $arg1, Str $arg2) : StrObject

The replace method performs a regular expression substitution on the given string. The first argument is the string to match against. The second argument is the replacement string. The optional third argument might be a string representing flags to append to the s///x operator, such as 'g' or 'e'. This method will always return a Data::Object::Replace object which can be used to introspect the result of the operation.

replace example

  # given qr(test)

  $re->replace('this is a test', 'drill');
  $re->replace('test 1 test 2 test 3', 'drill', 'gi');

search

  search(Str $arg1) : SearchObject

The search method performs a regular expression match against the given string This method will always return a Data::Object::Search object which can be used to introspect the result of the operation.

search example

  # given qr((test))

  $re->search('this is a test');
  $re->search('this does not match', 'gi');

CREDITS

Al Newkirk, +319

Anthony Brummett, +10

Adam Hopkins, +2

José Joaquín Atria, +1

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated here, https://github.com/iamalnewkirk/do/blob/master/LICENSE.

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues

SEE ALSO

To get the most out of this distribution, consider reading the following:

Do

Data::Object

Data::Object::Class

Data::Object::ClassHas

Data::Object::Role

Data::Object::RoleHas

Data::Object::Library

cpanm Do

perl -MCPAN -e shell
install Do