CDBEnumerator Class Reference

#import <CDBFile.h>

List of all members.


Detailed Description

Enumerator for key/value pairs in a CDBReader.

Returned from -[CDBReader keyEnumerator].

Public Member Functions

(id) - nextObject
 Standard NSEnumerator method; returns the next key copied into an NSData object.
(BOOL) - next
 Advances to the next item, without returning the key as an object.

Properties

readonly CDBData keyPointer
 A direct pointer to the current key.
readonly CDBData valuePointer
 A direct pointer to the current value.


Member Function Documentation

- (id) nextObject  

Standard NSEnumerator method; returns the next key copied into an NSData object.

- (BOOL) next  

Advances to the next item, without returning the key as an object.

This is slightly faster, if you don't need the key in that form. You can then access the keyPointer or valuePointer properties to read the key/value.

Returns:
YES on success, or NO at the end.


Property Documentation

- (CDBData) keyPointer

A direct pointer to the current key.

This points directly into the memory-mapped file, without any copying, so it's very efficient. But the memory pointed to only remains valid until the CDBReader is closed. Before the first call to -next or -nextObject, this will point to NULL.

- (CDBData) valuePointer

A direct pointer to the current value.

This points directly into the memory-mapped file, without any copying, so it's very efficient. But the memory pointed to only remains valid until the CDBReader is closed. Before the first call to -next or -nextObject, this will point to NULL.


The documentation for this class was generated from the following files:
Generated on Thu Mar 6 12:20:55 2008 for CDBStore by  doxygen 1.5.4