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

NAME

Role::TinyCommons::Collection::GetItemByKey - Locating an item by a key

VERSION

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

SYNOPSIS

DESCRIPTION

This role is for ordered/mapping collections that support subscripting operation: locating an item via a single key (an integer like in an array, or a string like in a hash).

REQUIRED METHODS

get_item_at_key

Usage:

my $item = $obj->get_item_at_key($key); # dies when not found

Return item at key $key. Method must die when there is no item at such key.

has_item_at_key

Usage:

my $has_item = $obj->has_item_at_key($key); # => bool

Check whether the collection has item at key $key. In Perl, this is equivalent to doing exists() on a hash.

get_all_keys

Usage:

my @keys = $obj->get_all_keys;

Return all known keys. Note that a specific order is not required.

PROVIDED METHODS

has_key

Alias for "has_item_at_key".

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::GetItemByPos

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.