| DBM::Deep::Iterator::File::Index(3pm) | User Contributed Perl Documentation | DBM::Deep::Iterator::File::Index(3pm) |
DBM::Deep::Iterator::Index - mediate between DBM::Deep::Iterator and DBM::Deep::Engine::Sector::Index
This is an internal-use-only object for DBM::Deep. It acts as the mediator between the DBM::Deep::Iterator object and a DBM::Deep::Engine::Sector::Index sector.
This object, despite the implied class hierarchy, does NOT inherit from DBM::Deep::Iterator. Instead, it delegates to it, essentially acting as a facade over it. "get_next_key" in DBM::Deep::Iterator will instantiate one of these objects as needed to handle an Index sector.
The constructor takes a hashref of params and blesses it into the invoking class. The hashref is assumed to have the following elements:
This takes no arguments.
This returns true/false indicating whether this sector has any more elements that can be iterated over.
This takes no arguments.
This returns an iterator (built by "get_sector_iterator" in DBM::Deep::Iterator) based on the sector pointed to by the next occupied location in this index.
If the sector is exhausted, it returns nothing.
| 2018-05-23 | perl v5.26.2 |