1DBM::Deep::Iterator::FiUlsee:r:ICnodnetxr(i3b)uted PerlDDBoMc:u:mDeenetpa:t:iIotnerator::File::Index(3)
2
3
4
6 DBM::Deep::Iterator::Index - mediate between DBM::Deep::Iterator and
7 DBM::Deep::Engine::Sector::Index
8
10 This is an internal-use-only object for DBM::Deep. It acts as the
11 mediator between the DBM::Deep::Iterator object and a
12 DBM::Deep::Engine::Sector::Index sector.
13
15 This object, despite the implied class hierarchy, does NOT inherit from
16 DBM::Deep::Iterator. Instead, it delegates to it, essentially acting as
17 a facade over it. "get_next_key" in DBM::Deep::Iterator will
18 instantiate one of these objects as needed to handle an Index sector.
19
21 new(\%params)
22 The constructor takes a hashref of params and blesses it into the
23 invoking class. The hashref is assumed to have the following elements:
24
25 • iterator (of type DBM::Deep::Iterator
26
27 • sector (of type DBM::Deep::Engine::Sector::Index
28
29 at_end()
30 This takes no arguments.
31
32 This returns true/false indicating whether this sector has any more
33 elements that can be iterated over.
34
35 get_next_iterator()
36 This takes no arguments.
37
38 This returns an iterator (built by "get_sector_iterator" in
39 DBM::Deep::Iterator) based on the sector pointed to by the next
40 occupied location in this index.
41
42 If the sector is exhausted, it returns nothing.
43
44
45
46perl v5.32.1 2021-01-27DBM::Deep::Iterator::File::Index(3)