.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BSON::Regex 3pm"
.TH BSON::Regex 3pm "2018-12-09" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
BSON::Regex \- BSON type wrapper for regular expressions
.SH "VERSION"
.IX Header "VERSION"
version v1.10.2
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use BSON::Types \*(Aq:all\*(Aq;
\&
\&    $regex = bson_regex( $pattern );
\&    $regex = bson_regex( $pattern, $flags );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a \s-1BSON\s0 type wrapper for a \s-1PCRE\s0 regular expression and
optional flags.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "pattern"
.IX Subsection "pattern"
A \fBstring\fR containing a \s-1PCRE\s0 regular expression pattern (not a \f(CW\*(C`qr\*(C'\fR object
and without slashes).  Default is the empty string.
.SS "flags"
.IX Subsection "flags"
A string with regular expression flags.  Flags will be sorted and
duplicates will be removed during object construction.  Supported flags
include \f(CW\*(C`imxlsu\*(C'\fR.  Invalid flags will cause an exception.
Default is the empty string.
.SH "METHODS"
.IX Header "METHODS"
.SS "try_compile"
.IX Subsection "try_compile"
.Vb 1
\&    my $qr = $regexp\->try_compile;
.Ve
.PP
Tries to compile the \f(CW\*(C`pattern\*(C'\fR and \f(CW\*(C`flags\*(C'\fR into a reference to a regular
expression.  If the pattern or flags can't be compiled, a
exception will be thrown.
.PP
\&\fB\s-1SECURITY NOTE\s0\fR: Executing a regular expression can evaluate arbitrary
code if the re 'eval' pragma is in force.  You are strongly advised
to read re and never to use untrusted input with \f(CW\*(C`try_compile\*(C'\fR.
.SS "\s-1TO_JSON\s0"
.IX Subsection "TO_JSON"
If the \f(CW\*(C`BSON_EXTJSON\*(C'\fR option is true, returns a hashref compatible with
MongoDB's extended \s-1JSON\s0 <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst>
format, which represents it as a document as follows:
.PP
.Vb 1
\&    {"$regularExpression" : { pattern: "<pattern>", "options" : "<flags>"} }
.Ve
.PP
If the \f(CW\*(C`BSON_EXTJSON\*(C'\fR option is false, an error is thrown, as this value
can't otherwise be represented in \s-1JSON.\s0
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <david@mongodb.com>
.IP "\(bu" 4
Stefan G. <minimalist@lavabit.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2018 by Stefan G. and MongoDB, Inc.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve