/ 
ArrayDataRoles-Standard-0.002
River stage two • 8 direct dependents • 11 total dependents
/ ArrayDataRole::Source::Iterator

NAME

ArrayDataRole::Source::Iterator - Get array data from an iterator

VERSION

This document describes version 0.002 of ArrayDataRole::Source::Iterator (from Perl distribution ArrayDataRoles-Standard), released on 2021-04-20.

SYNOPSIS

package ArrayData::YourArray;
use Role::Tiny::With;
with 'ArrayDataRole::Source::Iterator';

sub new {
    my $class = shift;
    $class->_new(
        gen_iterator => sub {
            return sub {
                ...
            };
        },
    );
}

DESCRIPTION

This role retrieves elements from a simplistic iterator (a coderef). When called, the iterator must return a non-undef element or undef to signal that all elements have been iterated.

reset_iterator() will regenerate a new iterator.

ROLES MIXED IN

ArrayDataRole::Spec::Basic

METHODS

_new

Create object. This should be called by a consumer's new. Usage:

my $ary = $CLASS->_new(%args);

Arguments:

  • gen_iterator

    Coderef. Required. Must return another coderef which is the iterator.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/ArrayDataRoles-Standard.

SOURCE

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

BUGS

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

ArrayData

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.