Data::Stream::Bulk::DoneFlag: Implement the "is_done" method in terms of a flag

VERSION

version 0.11

SYNOPSIS

        package Data::Stream::Bulk::Blah;
        use Moose;

        with qw(Data::Stream::Bulk::DoneFlag);

        sub get_more {
                if ( my @more = more() ) {
                        return \@more;
                } else {
                        return;
                }
        }

DESCRIPTION

This role implements the \*(C`Data::Stream::Bulk\*(C' core \s-1API\s0 in terms of one method (\*(C`get_more\*(C').

As a convenience it calls \*(C`finished\*(C' when the stream is exhausted, so that cleanup may be done.

This is used by classes like Data::Stream::Bulk::DBI, Data::Stream::Bulk::Callback.

METHODS

is_done: Returns the state of the iterator.
next: As long as the iterator is not yet done, calls \*(C`get_more\*(C'. If \*(C`get_more\*(C' returned a false value instead of an array reference then \*(C`done\*(C' is set, \*(C`finished\*(C' is called, and this \*(C`next\*(C' does nothing on subsequent calls.
finished: A noop by default. Can be overridden if so desired.

REQUIRED_METHODS

get_more: Returns the next block of data as an array ref, or a false value if no items are left.

AUTHOR

Yuval Kogman <[email protected]>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Data::Stream::Bulk::DoneFlag (3pm)