.\" Automatically generated by Pod::Man 4.11 (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 "Data::DPath::Path 3pm"
.TH Data::DPath::Path 3pm "2019-10-24" "perl v5.30.0" "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"
Data::DPath::Path \- Abstraction for a DPath
.SH "ABOUT"
.IX Header "ABOUT"
Take a string description, parse it, provide frontend methods.
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.ie n .SS "new ( %args )"
.el .SS "new ( \f(CW%args\fP )"
.IX Subsection "new ( %args )"
Constructor; creates instance.
.PP
Args:
.IP "give_references" 4
.IX Item "give_references"
Default 0. If set to true value then results are references to the
matched points in the data structure.
.ie n .SS "match( $data )"
.el .SS "match( \f(CW$data\fP )"
.IX Subsection "match( $data )"
Returns an array of all values in \f(CW$data\fR that match the Path object.
.ie n .SS "matchr( $data )"
.el .SS "matchr( \f(CW$data\fP )"
.IX Subsection "matchr( $data )"
Returns an array ref of all values in \f(CW$data\fR that match the Path object.
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.ie n .SS "op_match( $self, $data )"
.el .SS "op_match( \f(CW$self\fP, \f(CW$data\fP )"
.IX Subsection "op_match( $self, $data )"
This sub/method is bound as the overloading function for \f(CW\*(C`~~\*(C'\fR.
.SS "quoted"
.IX Subsection "quoted"
Checks whether a path part starts with quotes.
.SS "unquote"
.IX Subsection "unquote"
Removes surrounding quotes.
.SS "unescape"
.IX Subsection "unescape"
Converts backslashed characters into their non-backslashed form.
.SS "_build_\|_steps"
.IX Subsection "_build__steps"
This method is essentially the DPath parser as it tokenizes the path
into single steps whose later execution is the base functionality of
the whole DPath module.
.SS "path"
.IX Subsection "path"
Attribute / accessor.
.SS "_steps"
.IX Subsection "_steps"
Attribute / accessor.
.SS "give_references"
.IX Subsection "give_references"
Attribute / accessor.
.SH "aliased classes"
.IX Header "aliased classes"
That's just to make Pod::Coverage happy which does not handle aliased
modules.
.SS "Context"
.IX Subsection "Context"
.SS "Point"
.IX Subsection "Point"
.SS "Step"
.IX Subsection "Step"
.SH "AUTHOR"
.IX Header "AUTHOR"
Steffen Schwigon <ss5@renormalist.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019 by Steffen Schwigon.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.