.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Filters 3pm"
.TH Data::DPath::Filters 3pm "2023-10-26" "perl v5.36.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::Filters \- Magic functions available inside filter conditions
.SH "API METHODS"
.IX Header "API METHODS"
.SS "affe"
.IX Subsection "affe"
Mysterious test function. Will vanish. Soon. Or will it really? No,
probably not. I like it. :\-)
.PP
Returns true if the value eq \*(L"affe\*(R".
.SS "idx"
.IX Subsection "idx"
Returns the current index inside array elements.
.PP
Please note that the current matching elements might not be in a
defined order if resulting from anything else than arrays.
.SS "size"
.IX Subsection "size"
Returns the size of the current element. If it is an array ref it
returns the number of elements, if it is a hash ref it returns number of keys,
if it is a scalar it returns 1, everything else returns \-1.
.SS "key"
.IX Subsection "key"
If it is a hashref returns the key under which the current element is
associated as value. Else it returns undef.
.PP
This gives the \fBkey()\fR function kind of a \*(L"look back\*(R" behaviour because
the associated point is already after that key.
.SS "value"
.IX Subsection "value"
Returns the value of the current element.
.SS "isa"
.IX Subsection "isa"
Frontend to UNIVERSAL::isa. True if the current element is_a given
class.
.SS "reftype"
.IX Subsection "reftype"
Frontend to Scalar::Util::reftype.
.PP
Returns Scalar::Util::reftype of current element \f(CW$_\fR. With this you can
do comparison by yourself with \f(CW\*(C`eq\*(C'\fR, \f(CW\*(C`=~\*(C'\fR, \f(CW\*(C`~~\*(C'\fR or whatever in
filter expressions.
.SS "is_reftype($EXPECTED_TYPE)"
.IX Subsection "is_reftype($EXPECTED_TYPE)"
Frontend to Scalar::Util::reftype.
.PP
Checks whether Scalar::Util::reftype of current element \f(CW$_\fR equals the
provided argument \f(CW$EXPECTED_TYPE\fR and returns true/false.
.SH "AUTHOR"
.IX Header "AUTHOR"
Steffen Schwigon <ss5@renormalist.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2023 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.