NAME

Role::TinyCommons::Iterator::Resettable - A resettable iterator

VERSION

This document describes version 0.004 of Role::TinyCommons::Iterator::Resettable (from Perl distribution RoleBundle-TinyCommons-Iterator), released on 2021-10-07.

DESCRIPTION

A resettable iterator is just like a basic iterator except that it has "reset_iterator" to reset the iterator position back to the beginning.

ROLES MIXED IN

Role::TinyCommons::Iterator::Basic

REQUIRED METHODS

reset_iterator

Reset the iterator, which means the subsequent get_next_item() should get the first item again, and the subsequent get_iterator_pos() right before any getting of more items should return 0.

PROVIDED METHODS

get_all_items

Usage:

 my @items = $obj->get_all_items;

Return a list containing all the items. Equivalent to:

 do {
     $obj->reset_iterator;
     my @items;
     while ($obj->has_next_item) {
         push @items, $obj->get_next_item;
     }
     @items;
 }

get_item_count

Usage:

 my $count = $obj->get_item_count;

Return the number of items. Equivalent to:

 do {
     $obj->reset_iterator;
     my $count = 0;
     while ($obj->has_next_item) {
         $obj->get_next_item;
         $count++;
     }
     $count;
 }

each_item

Usage:

 $obj->each_item($coderef);

Call $coderef for each item. If $coderef returns false, will immediately return false and skip the rest of the items. Otherwise, will return true. Equivalent to:

 $obj->reset_iterator;
 my $pos = 0;
 while ($obj->has_next_item) {
     my $item = $obj->get_next_item;
     my $res = $coderef->($item, $obj, $pos);
     return 0 unless $res;
     $pos++;
 }
 return 1;

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/RoleBundle-TinyCommons-Iterator.

SOURCE

Source repository is at https://github.com/perlancar/perl-RoleBundle-TinyCommons-Iterator.

SEE ALSO

Role::TinyCommons::Iterator::Basic

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=RoleBundle-TinyCommons-Iterator

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

cpanm RoleBundle::TinyCommons::Iterator

perl -MCPAN -e shell
install RoleBundle::TinyCommons::Iterator