From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

OVID / WebService-OpenSky-0.5 / lib / WebService / OpenSky / Utils / Iterator.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
—
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

              
package WebService::OpenSky::Utils::Iterator;
# ABSTRACT: Internal iterator class for WebService::OpenSky
use WebService::OpenSky::Moose;
use WebService::OpenSky::Types qw(
  ArrayRef
  Defined
  InstanceOf
  PositiveOrZeroInt
);
our $VERSION = '0.5';
param rows => (
    isa    => ArrayRef [Defined],
    reader => '_rows',
);
field '_index' => (
    writer  => '_set_index',
    isa     => PositiveOrZeroInt,
    default => 0,
);
method first() {
    return $self->_rows->[0];
}
method next() {    ## no critic (Subroutines::ProhibitBuiltinHomonyms)
    my $i    = $self->_index;
    my $next = $self->_rows->[$i] or return;
    $self->_set_index( $i + 1 );
    return $next;
}
method reset() {    ## no critic (Subroutines::ProhibitBuiltinHomonyms)
    $self->_set_index(0);
    return 1;
}
method all() {
    return @{ $self->_rows };
}
method count() {
    my @all = $self->all;
    return scalar @all;
}
__END__
=pod
=encoding UTF-8
=head1 NAME
WebService::OpenSky::Utils::Iterator - Internal iterator class for WebService::OpenSky
=head1 VERSION
version 0.5
=head1 SYNOPSIS
    use WebService::OpenSky::Utils::Iterator;
    my $results = WebService::OpenSky::Utils::Iterator->new( rows => [ 1, 2, 3 ] );
    while ( my $result = $results->next ) {
        ...
    }
=head1 DESCRIPTION
A simple iterator class. To keep it dead simple, it only allows defined values
to be passed in.
=head1 METHODS
=head2 C<next>
    while ( my $result = $results->next ) {
        ...
    }
Returns the next member in the iterator. Returns C<undef> if the iterator is
exhausted.
=head2 C<count>
    if ( $results->count ) {
        ...
    }
Returns the number of members in the iterator.
=head2 C<first>
    my $object = $results->first;
Returns the first object in the results.
=head2 C<reset>
    $results->reset;
Resets the iterator to point to the first member.
=head2 C<all>
    my @objects = $results->all;
Returns a list of all members in the iterator.
=head1 AUTHOR
Curtis "Ovid" Poe <curtis.poe@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2023 by Curtis "Ovid" Poe.
This is free software, licensed under:
  The Artistic License 2.0 (GPL Compatible)
=cut