Attean::API::PullParser - Role for parsers that natively return an iterator
Contents
Bugs
Please report any bugs or feature requests to through the GitHub web interface at
<https://github.com/kasei/attean/issues>.
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.
perl v5.40.0 2025-01-26 Attean::API::PullParser(3pm)
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.
Methods
This role provides default implementations of the following methods:
parse_cb_from_io( $fh )
Calls the "$parser->handler" function once for each object that result from parsing the data read
from the IO::Handle object $fh.
parse_cb_from_bytes( $data )
Calls the "$parser->handler" function once for each object that result from parsing the data read
from the UTF-8 encoded byte string $data.
parse_list_from_io( $fh )
Returns a list of all objects that result from parsing the data read from the IO::Handle object $fh.
parse_list_from_bytes( $data )
Returns a list of all objects that result from parsing the data read from the UTF-8 encoded byte
string $data.
Name
Attean::API::PullParser - Role for parsers that natively return an iterator
Required Methods
Classes consuming this role must provide the following methods:
parse_iter_from_io( $fh )
Returns an Attean::API::Iterator that result from parsing the data read from the IO::Handle object
$fh.
parse_iter_from_bytes( $data )
Returns an Attean::API::Iterator that result from parsing the data read from the UTF-8 encoded byte
string $data.
Roles
This role consumes the Attean::API::Parser role.
See Also
Version
This document describes Attean::API::PullParser version 0.035
