dictionary_cursor Struct Reference

A supertype for dictionary cursor objects. More...

#include <dictionary_types.h>

Collaboration diagram for dictionary_cursor:

Public Attributes

ion_cursor_status_t status
ion_cursor_status_t(* next )(ion_dict_cursor_t *, ion_record_t *record)
void(* destroy )(ion_dict_cursor_t **)

Detailed Description

A supertype for dictionary cursor objects.

This is a super type. The state information must be stored within a subtype that makes sense to the particular dictionary implementation.

There are different types of cursors for different types of dictionary operations.

Definition at line 398 of file dictionary_types.h.

Member Data Documentation

void(* dictionary_cursor::destroy) (ion_dict_cursor_t **)

A pointer to the function used to destroy the cursor (frees internal memory).

Definition at line 411 of file dictionary_types.h.

ion_dictionary_t* dictionary_cursor::dictionary

A pointer to the dictionary object.

Definition at line 400 of file dictionary_types.h.

ion_cursor_status_t(* dictionary_cursor::next) (ion_dict_cursor_t *, ion_record_t *record)

A pointer to the next function, which sets ion_cursor_status_t).

Definition at line 405 of file dictionary_types.h.

ion_predicate_t* dictionary_cursor::predicate

The predicate for the cursor.

Definition at line 402 of file dictionary_types.h.

ion_cursor_status_t dictionary_cursor::status

Status of last cursor call.

Definition at line 399 of file dictionary_types.h.

The documentation for this struct was generated from the following file: