File Coverage

blib/lib/Sah/Schema/re_from_str.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

package Sah::Schema::re_from_str;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-12-20'; # DATE
our $DIST = 'Sah-Schemas-Re'; # DIST
our $VERSION = '0.006'; # VERSION

our $schema = [
    re => {
        summary => 'Regexp object from string using Regexp::From::String\'s str_to_re()',
        description => <<'MARKDOWN',

This schema accepts Regexp object or string which will be coerced to Regexp object
using 's `str_to_re()` function.

Basically, if string is of the form of `/.../` or `qr(...)`, then you could
specify metacharacters as if you are writing a literal regexp pattern in Perl.
Otherwise, your string will be `quotemeta()`-ed first then compiled to Regexp
object. This means in the second case you cannot specify metacharacters.

What's the difference between this schema and `str_or_re` (from
)? Both this schema and `str_or_re` accept string, but
this schema will still coerce strings not in the form of `/.../` or `qr(...)` to
regexp object, while `str_or_re` will leave the string as-is. In other words,
this schema always converts input to Regexp object while `str_or_re` does not.

MARKDOWN

        prefilters => [ ['Re::re_from_str'=>{}] ],

        examples => [
        ],
    },
];

1;
# ABSTRACT: Regexp object from string

__END__