blib/lib/DBM/Deep/Iterator/File/Index.pm

filter: Statementstmt 100% 20 / 20 Branchbran 100% 4 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 6 / 6 Podpod 100% 3 / 3 totaltotal 100% 33 / 33 CC 3 SCAR 5.6
CC
3
Cov
100%
get_next_iterator
3.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.8
« blib/lib/DBM/Deep/Iterator/File/BucketList.pm ↑ Summary blib/lib/DBM/Deep/Storage.pm »
1 package DBM::Deep::Iterator::File::Index;
2  
3 48 ▶use 5.006_000;
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 48 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 48 ▶use warnings FATAL => 'all';
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 =head1 NAME
9  
10 DBM::Deep::Iterator::Index
11  
12 =head1 PURPOSE
13  
14 This is an internal-use-only object for L<DBM::Deep>. It acts as the mediator
15 between the L<DBM::Deep::Iterator> object and a L<DBM::Deep::Engine::Sector::Index>
16 sector.
17  
18 =head1 OVERVIEW
19  
20 This object, despite the implied class hiearchy, does B<NOT> inherit from
21 L<DBM::Deep::Iterator>. Instead, it delegates to it, essentially acting as a
22 facade over it. L<DBM::Deep::Iterator/get_next_key> will instantiate one of
23 these objects as needed to handle an Index sector.
24  
25 =head1 METHODS
26  
27 =head2 new(\%params)
28  
29 The constructor takes a hashref of params and blesses it into the invoking class. The
30 hashref is assumed to have the following elements:
31  
32 =over 4
33  
34 =item * iterator (of type L<DBM::Deep::Iterator>
35  
36 =item * sector (of type L<DBM::Deep::Engine::Sector::Index>
37  
38 =back
39  
40 =cut
41  
42 sub new {
43 16 ▶ my $self = bless $_[1] => $_[0];
Subroutine new: called CC=1 SCAR=0.0
Pod documented
44 16 $self->{curr_index} = 0;
45 16 return $self;
46 }
47  
48 =head2 at_end()
49  
50 This takes no arguments.
51  
52 This returns true/false indicating whether this sector has any more elements that can be
53 iterated over.
54  
55 =cut
56  
57 sub at_end {
58 4352 ▶ my $self = shift;
Subroutine at_end: called CC=1 SCAR=0.0
Pod documented
59 4352 return $self->{curr_index} >= $self->{iterator}{engine}->hash_chars;
60 }
61  
62 =head2 get_next_iterator()
63  
64 This takes no arguments.
65  
66 This returns an iterator (built by L<DBM::Deep::Iterator/get_sector_iterator>) based
67 on the sector pointed to by the next occupied location in this index.
68  
69 If the sector is exhausted, it returns nothing.
70  
71 =cut
72  
73 sub get_next_iterator {
74 224 ▶ my $self = shift;
Subroutine get_next_iterator: called CC=3 SCAR=11.0
Pod documented
75  
76 224 my $loc;
77 224 ▶ while ( !$loc ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($loc) 4112 208 4320
78 4112 ▶ return if $self->at_end;
Branch: 1 branch
BranchTrueFalseTotal
if $self->at_end 16 4096 4112
79 4096 $loc = $self->{sector}->get_entry( $self->{curr_index}++ );
80 }
81  
82 208 return $self->{iterator}->get_sector_iterator( $loc );
83 }
84  
85 48 1;
86 __END__
« blib/lib/DBM/Deep/Iterator/File/BucketList.pm ↑ Summary blib/lib/DBM/Deep/Storage.pm »