NAME

Iterator::Flex::Role::Exhaustion::Return - signal exhaustion by returning a sentinel value.

VERSION

version 0.18

METHODS

sentinel

$sentinel = $iterator->sentinel

returns the sentinel which the iterator will return to signal exhaustion

signal_exhaustion

$sentinel = $iterator->signal_exhaustion;

Signal that the iterator is exhausted, by calling $self->set_exhausted and returning the iterator's sentinel value.

INTERNALS

SUPPORT

Bugs

Please report any bugs or feature requests to bug-iterator-flex@rt.cpan.org or through the web interface at: https://rt.cpan.org/Public/Dist/Display.html?Name=Iterator-Flex

Source

Source is available at

https://gitlab.com/djerius/iterator-flex

and may be cloned from

https://gitlab.com/djerius/iterator-flex.git

SEE ALSO

Please see those modules/websites for more information related to this module.

AUTHOR

Diab Jerius <djerius@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Smithsonian Astrophysical Observatory.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007