NAME

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

VERSION

This document describes version 0.007 of Role::TinyCommons::Collection::GetItemByKey (from Perl distribution Role-TinyCommons-Collection), released on 2021-05-07.

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.

get_all_keys

Usage:

my @keys = $obj->get_all_keys;

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

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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-Role-TinyCommons-Collection/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::Collection::GetItemByPos

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.

cpanm Role::TinyCommons::Collection

perl -MCPAN -e shell
install Role::TinyCommons::Collection