1Attean::IteratorSequencUes(e3r)Contributed Perl DocumentAatttieoann::IteratorSequence(3)
2
3
4

NAME

6       Attean::IteratorSequence - Iterator implementation backed by zero or
7       more sub-iterators
8

VERSION

10       This document describes Attean::IteratorSequence version 0.025
11

SYNOPSIS

13         use v5.14;
14         use Attean;
15         my $iter = Attean::IteratorSequence->new(iterators => [$iter1, $iter2]);
16

DESCRIPTION

18       The Attean::IteratorSequence class represents a typed iterator that is
19       backed by zero or more sub-iterators. When iterated over, it will
20       return all the elements of all of its sub-iterators, in order, before
21       returning undef.  It conforms to the Attean::API::Iterator role.
22
23       The Attean::IteratorSequence constructor requires two named arguments:
24
25       iterators
26           An array reference containing zero or more Attean::API::Iterator
27           objects.
28
29       item_type
30           A string representing the type of the items that will be returned
31           from the iterator.
32

METHODS

34       "next"
35           Returns the iterator's next item, or undef upon reaching the end of
36           iteration.
37
38       "push( $iterator )"
39           Adds the new $iterator to the end of the array of sub-iterators.
40
41           After this call, $iterator will be owned by the IteratorSequence,
42           so making any method calls on $iterator after this point may
43           produce unexpected results.
44

BUGS

46       Please report any bugs or feature requests to through the GitHub web
47       interface at <https://github.com/kasei/attean/issues>.
48

SEE ALSO

AUTHOR

51       Gregory Todd Williams  "<gwilliams@cpan.org>"
52
54       Copyright (c) 2014--2019 Gregory Todd Williams.  This program is free
55       software; you can redistribute it and/or modify it under the same terms
56       as Perl itself.
57
58
59
60perl v5.30.1                      2020-01-29       Attean::IteratorSequence(3)
Impressum