/ 
ArrayData-0.2.6
River stage two • 3 direct dependents • 13 total dependents
/ ArrayDataRole::Spec::Basic

NAME

ArrayDataRole::Spec::Basic - Required methods for all ArrayData::* modules

VERSION

This document describes version 0.2.6 of ArrayDataRole::Spec::Basic (from Perl distribution ArrayData), released on 2024-01-16.

DESCRIPTION

ArrayData::* modules let you iterate elements using a resettable iterator interface (Role::TinyCommons::Iterator::Resettable) as well as get elements by position (Role::TinyCommons::Collection::GetItemByPos), like what a regular Perl array lets you.

It allows an array with infinite number of elements.

category                     method name                note                        modifies iterator?
--------                     -----------                -------                     ------------------
instantiating                new(%args)                                             N/A

iterating items              has_next_item()                                        no
                             get_next_item()                                        yes (moves forward 1 position)
                             reset_iterator()                                       yes (resets)

iterating items (alt)        each_item()                                            yes (resets)

getting all items            get_all_items()                                        yes (resets)

getting item count           get_item_count()                                       yes (resets) / no (for some implementations)

utility: applying roles      apply_roles(R1, R2, ...)                               N/A

ROLES MIXED IN

Role::TinyCommons::Iterator::Resettable

Role::TinyCommons::Collection::GetItemByPos

REQUIRED METHODS

new

Usage:

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

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

get_next_item

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

has_next_item

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

reset_iterator

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

get_item_at_pos

From Role::TinyCommons::Collection::GetItemByPos.

Should reset iterator.

has_item_at_pos

From Role::TinyCommons::Collection::GetItemByPos.

Can reset iterator if required.

get_item_count

Provided by Role::TinyCommons::Collection::GetItemByPos, but you can provide a more efficient implementation.

Get number of elements of array. Must return -1 to mean an array with infinite number of elements. Can reset iterator if required.

PROVIDED METHODS

each_item

From Role::TinyCommons::Collection::GetItemByPos. But if you have an infinite array data, this method will loop endlessly; you can provide your own implementation to prevent this from happening.

get_all_items

From Role::TinyCommons::Collection::GetItemByPos. But if you have an infinite array data, this method will loop and collect endlessly; you can provide your own implementation to prevent this from happening.

apply_roles

Usage:

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

Apply roles to object. R1, R2, ... are unqualified role names that will be searched under ArrayDataRole::* 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 = ArrayData::Word::ID::KBBI->new->apply_roles('FindItem::Iterator', 'PickItems::RandomPos');

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

HOMEPAGE

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

SOURCE

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

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=ArrayData

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.