.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Attean::API::PullParser 3pm"
.TH Attean::API::PullParser 3pm "2022-10-06" "perl v5.34.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"
Attean::API::PullParser \- Role for parsers that natively return an iterator
.SH "VERSION"
.IX Header "VERSION"
This document describes Attean::API::PullParser version 0.033
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Attean::API::PullParser role defines parsers that can efficiently construct
and return an iterator of the parsed data. This role adds methods that
builds on this functionality to allow parsing data using different approaches.
.SH "ROLES"
.IX Header "ROLES"
This role consumes the Attean::API::Parser role.
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
Classes consuming this role must provide the following methods:
.ie n .IP """parse_iter_from_io( $fh )""" 4
.el .IP "\f(CWparse_iter_from_io( $fh )\fR" 4
.IX Item "parse_iter_from_io( $fh )"
Returns an Attean::API::Iterator that result from parsing the data read from
the IO::Handle object \f(CW$fh\fR.
.ie n .IP """parse_iter_from_bytes( $data )""" 4
.el .IP "\f(CWparse_iter_from_bytes( $data )\fR" 4
.IX Item "parse_iter_from_bytes( $data )"
Returns an Attean::API::Iterator that result from parsing the data read from
the \s-1UTF\-8\s0 encoded byte string \f(CW$data\fR.
.SH "METHODS"
.IX Header "METHODS"
This role provides default implementations of the following methods:
.ie n .IP """parse_cb_from_io( $fh )""" 4
.el .IP "\f(CWparse_cb_from_io( $fh )\fR" 4
.IX Item "parse_cb_from_io( $fh )"
Calls the \f(CW\*(C`$parser\->handler\*(C'\fR function once for each object that result
from parsing the data read from the IO::Handle object \f(CW$fh\fR.
.ie n .IP """parse_cb_from_bytes( $data )""" 4
.el .IP "\f(CWparse_cb_from_bytes( $data )\fR" 4
.IX Item "parse_cb_from_bytes( $data )"
Calls the \f(CW\*(C`$parser\->handler\*(C'\fR function once for each object that result
from parsing the data read from the \s-1UTF\-8\s0 encoded byte string \f(CW$data\fR.
.ie n .IP """parse_list_from_io( $fh )""" 4
.el .IP "\f(CWparse_list_from_io( $fh )\fR" 4
.IX Item "parse_list_from_io( $fh )"
Returns a list of all objects that result from parsing the data read from the
IO::Handle object \f(CW$fh\fR.
.ie n .IP """parse_list_from_bytes( $data )""" 4
.el .IP "\f(CWparse_list_from_bytes( $data )\fR" 4
.IX Item "parse_list_from_bytes( $data )"
Returns a list of all objects that result from parsing the data read from the
\&\s-1UTF\-8\s0 encoded byte string \f(CW$data\fR.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/attean/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2022 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.