.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Attean::CodeIterator 3pm"
.TH Attean::CodeIterator 3pm "2021-02-14" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Attean::CodeIterator \- Iterator implementation backed by a generator function
.SH "VERSION"
.IX Header "VERSION"
This document describes Attean::CodeIterator version 0.030
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\&  use v5.14;
\&  use Attean;
\&  my $iter = Attean::CodeIterator\->new(
\&    generator => sub {
\&      state $value = 0;
\&      Attean::Literal\->new(++$value)
\&    },
\&    item_type => \*(AqAttean::API::Term\*(Aq,
\&  );
\&  
\&  say $iter\->next\->value; # 1
\&  say $iter\->next\->value; # 2
\&  say $iter\->next\->value; # 3
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Attean::CodeIterator class represents a typed iterator.
It conforms to the Attean::API::Iterator role.
.PP
The Attean::CodeIterator constructor requires two named arguments:
.IP "generator" 4
.IX Item "generator"
A code reference that when called will return either the iterator's next item,
or undef upon reaching the end of iteration.
.IP "item_type" 4
.IX Item "item_type"
A Type::Tiny object representing the type of the items
that will be returned from the iterator.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """next""" 4
.el .IP "\f(CWnext\fR" 4
.IX Item "next"
Returns the iterator's next item, or undef upon reaching the end of iteration.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/attean/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2020 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.