NAME
Role::TinyCommons::Iterator::Circular - A cicular iterator
VERSION
This document describes version 0.004 of Role::TinyCommons::Iterator::Circular (from Perl distribution RoleBundle-TinyCommons-Iterator), released on 2021-10-07.
DESCRIPTION
A circular iterator is just like a basic iterator except that it will never run out of items (unless it is empty). When the last item has been retrieved, the position will move back to the beginning; get_iterator_pos
will return 0 again and get_next_item
will retrieve the first item.
ROLES MIXED IN
Role::TinyCommons::Iterator::Basic
REQUIRED METHODS
No additional required methods.
PROVIDED METHODS
get_all_items
get_item_count
each_item
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
Role::TinyCommons::Iterator::Resettable
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.