The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
HashData-0.1.2
River stage one • 2 direct dependents • 9 total dependents
/ HashDataRole::Spec::Basic

NAME

HashDataRole::Spec::Basic - Required methods for all HashData::* classes

VERSION

This document describes version 0.1.2 of HashDataRole::Spec::Basic (from Perl distribution HashData), released on 2024-01-22.

DESCRIPTION

HashData::* classes let you iterate pairs using a resettable iterator interface (Role::TinyCommons::Iterator::Resettable) as well as get values by key (Role::TinyCommons::Collection::GetItemByPos), like what a regular Perl hash lets you.

ROLES MIXED IN

Role::TinyCommons::Iterator::Resettable

Role::TinyCommons::Collection::GetItemByKey

REQUIRED METHODS

new

Usage:

 my $ary = HashData::Foo->new([ %args ]);

Constructor. Must accept a pair of argument names and values.

get_next_item

From Role::TinyCommons::Iterator::Resettable. Will return an array(ref) containing two elements: [$key, $value].

has_next_item

From Role::TinyCommons::Iterator::Resettable.

reset_iterator

From Role::TinyCommons::Iterator::Resettable.

get_item_at_key

From Role::TinyCommons::Collection::GetItemByKey.

has_item_at_key

From Role::TinyCommons::Collection::GetItemByKey.

has_item_at_key

Alias for "has_item_at_key", From Role::TinyCommons::Collection::GetItemByKey.

get_all_keys

From Role::TinyCommons::Collection::GetItemByKey.

PROVIDED METHODS

apply_roles

Usage:

 $obj->apply_roles('R1', 'R2', ...)

Apply roles to object. R1, R2, ... are unqualified role names that will be searched under HashDataRole::* or Role::TinyCommons::Collection::* namespace. It's a convenience shortcut for Role::Tiny->apply_roles_to_object.

Return the object, so you can do something like this:

 my $obj = HashData::Dict::ID::KBBI->new->apply_roles('FindItem::Iterator', 'PickItems::Iterator');

 my $obj = HashData::Word::ID::KBBI->new->apply_roles('BinarySearch::LinesInHandle');

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/HashData.

SOURCE

Source repository is at https://github.com/perlancar/perl-HashData.

SEE ALSO

Role::TinyCommons::Iterator::Resettable

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) 2024, 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=HashData

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.