/ 
HashDataRoles-Standard-0.005
River stage one • 8 direct dependents • 8 total dependents
/ HashDataRole::Source::Iterator

NAME

HashDataRole::Source::Iterator - Get hash data from an iterator

VERSION

This document describes version 0.005 of HashDataRole::Source::Iterator (from Perl distribution HashDataRoles-Standard), released on 2024-11-04.

SYNOPSIS

package HashData::YourHash;
use Role::Tiny::With;
with 'HashDataRole::Source::Iterator';

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

DESCRIPTION

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

reset_iterator() will regenerate a new iterator.

Note: get_item_at_key() and has_item_at_key() are slow (O(n) in worst case) and inefficient because they regenerate iterator and iterate everytime. Caching might be added in the future to speed this up.

ROLES MIXED IN

HashDataRole::Spec::Basic

METHODS

_new

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

my $hash = $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/HashDataRoles-Standard.

SOURCE

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

SEE ALSO

HashData

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 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=HashDataRoles-Standard

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.