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

NAME

Role::TinyCommons::Collection::Subscript - Subscripting (key-ing) operation

VERSION

This document describes version 0.004 of Role::TinyCommons::Collection::Subscript (from Perl distribution Role-TinyCommons-Collection), released on 2021-05-03.

SYNOPSIS

DESCRIPTION

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

REQUIRED METHODS

get_item_at

Usage:

 my $item = $obj->get_item_at($subscript); # dies when not found

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

has_item_at

Usage:

 my $has_item = $obj->has_item_at($subscript); # => bool

Check whether the collection has item at subscript $subscript.

get_all_subscripts

Usage:

 my @subscripts = $obj->get_all_subscripts;

Return all known subscripts or 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

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.