The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Role::TinyCommons::Iterator::Circular - A cicular iterator

VERSION

This document describes version 0.001 of Role::TinyCommons::Iterator::Circular (from Perl distribution Role-TinyCommons-Iterator), released on 2021-04-18.

DESCRIPTION

A circular iterator is just like a regular iterator except that it will never run out of items (unless it is empty). When the last item has been retrieved, the index will just move back to the beginning; get_iterator_index will return 0 again and get_next_item will retrieve the first item.

ROLES MIXED IN

Role::TinyCommons::Iterator

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/Role-TinyCommons-Iterator.

SOURCE

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-Role-TinyCommons-Iterator/issues

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.

SEE ALSO

Role::TinyCommons::Iterator

Role::TinyCommons::Iterator::Resettable

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by 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.