/ 
Role-TinyCommons-Collection-0.009
River stage two • 12 direct dependents • 29 total dependents
/ Role::TinyCommons::Collection::FindItem::Iterator

NAME

Role::TinyCommons::Collection::FindItem::Iterator - Provides find_item() for iterators

VERSION

This document describes version 0.009 of Role::TinyCommons::Collection::FindItem::Iterator (from Perl distribution Role-TinyCommons-Collection), released on 2023-08-26.

DESCRIPTION

This role provides find_item() which searches linearly using each_item() and cmp_items(). each_item() is usually provided by an iterator.

ROLES MIXED IN

Role::TinyCommons::Collection::FindItem

REQUIRED METHODS

each_item

Provided by roles like in Role::TinyCommons::Iterator::Resettable or Role::TinyCommons::Iterator::Circular.

OPTIONALLY DEPENDED METHODS

cmp_items

Usage:

$res = $obj->cmp_items($item1, $item2); # returns either -1, 0, 1

For flexibility in searching. The method should accept two items and return either -1, 0, 1 like Perl's cmp or <=> operator. See also Role::TinyCommons::Collection::CompareItems for the more formal encapsulated form of this interface.

PROVIDED METHODS

find_item

Usage:

my @results = $obj->find_item(%args);

For more details, see "find_item" in Role::TinyCommons::Collection::FindItem. This module implements arguments item, all, and return_pos.

HOMEPAGE

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

SOURCE

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

SEE ALSO

Role::TinyCommons::Collection::FindItem

Role::TinyCommons::Iterator::Resettable, Role::TinyCommons::Iterator::Circular.

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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 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=Role-TinyCommons-Collection

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.