1 package DBM::Deep::Iterator;
6 use warnings FATAL => 'all';
14 This is an internal-use-only object for L<DBM::Deep>. It is the iterator
15 for FIRSTKEY() and NEXTKEY().
25 The constructor takes a hashref of params. The hashref is assumed to have the
30 =item * engine (of type L<DBM::Deep::Engine>
32 =item * base_offset (the base_offset of the invoking DBM::Deep object)
43 engine => $args->{engine},
44 base_offset => $args->{base_offset},
47 Scalar::Util::weaken( $self->{engine} );
56 This method takes no arguments.
58 It will reset the iterator so that it will start from the beginning again.
60 This method returns nothing.
64 sub reset { die "reset must be implemented in a child class" }
66 =head2 get_next_key( $obj )
70 sub get_next_key { die "get_next_key must be implemented in a child class" }