DBM::D...ketList(3pm)

Okay bestie, this is the DBM::Deep::Iterator::BucketList page from the User Contributed Perl Documentation. 💖

🌸 NAME 🌸

DBM::Deep::Iterator::BucketList — mediate between DBM::Deep::Iterator and DBM::Deep::Engine::Sector::BucketList

🎀 PURPOSE 🎀

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::BucketList sector. ✨

✨ OVERVIEW ✨

Okay so 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 BucketList sector. 💅

💅 METHODS 💅

🫶 new(\%params) 🫶

The constructor takes a hashref of params and blesses it into the invoking class. The hashref is assumed to have the following elements:

• iterator (of type DBM::Deep::Iterator)
• sector (of type DBM::Deep::Engine::Sector::BucketList)

💖 at_end() 💖

This takes no arguments.

This returns true/false indicating whether this sector has any more elements that can be iterated over. 🦋

🌈 get_next_iterator() 🌈

This takes no arguments.

This returns the next key pointed to by this bucketlist. This value is suitable for returning by FIRSTKEY or NEXTKEY(). If the bucketlist is exhausted, it returns nothing. 🌟

---

Signed off with perl v5.42.0 energy, dated 2023-11-13. 💜🫶