File Coverage

blib/lib/Iterator/Flex/Role/Exhaustion/Return.pm

Criterion	Covered	Total	%
statement	32	32	100.0
branch			n/a
condition			n/a
subroutine	10	10	100.0
pod	2	2	100.0
total	44	44	100.0

package Iterator::Flex::Role::Exhaustion::Return;

# ABSTRACT: signal exhaustion by returning a sentinel value.

use v5.28;
use strict;
use warnings;

our $VERSION = '0.33';

use Scalar::Util();
use Iterator::Flex::Utils qw[ :default REG_GENERAL REG_GP_EXHAUSTION ];
use Role::Tiny;
use experimental 'signatures';

use namespace::clean;









sub sentinel ( $self ) {
    return $REGISTRY{ refaddr $self }[REG_GENERAL][REG_GP_EXHAUSTION][1];
}










sub signal_exhaustion ( $self, @ ) {
    $self->set_exhausted;
    return $self->sentinel;
}


1;

#
# This file is part of Iterator-Flex
#
# 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
#

__END__