NAME
ArrayDataRole::Spec::Basic - Required methods for all ArrayData::* modules
VERSION
This document describes version 0.2.3 of ArrayDataRole::Spec::Basic (from Perl distribution ArrayData), released on 2021-05-18.
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.
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::Iterator::GetItemByPos.
has_item_at_pos
From Role::TinyCommons::Iterator::GetItemByPos.
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 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::Iterator');
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.
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-ArrayData/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::Iterator::Resettable
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.