flat_file_types.h File Reference

Description

Implementation specific type definitions for the flat file store.

Author
Eric Huang
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1.Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2.Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3.Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file flat_file_types.h.

Include dependency graph for flat_file_types.h:
This graph shows which files directly or indirectly include this file:

Classes

struct  ion_flat_file_t
 Metadata container that holds flat file specific information. More...
 
struct  ion_flat_file_row_t
 Container for the rows written in the flat file data file. More...
 
struct  ion_flat_file_cursor_t
 Implementation cursor type for the flat file store cursor. More...
 

Macros

#define ION_FLAT_FILE_STATUS_OCCUPIED   1
 Signifies that this row in the flat file is currently occupied and should not be overwritten. More...
 
#define ION_FLAT_FILE_STATUS_EMPTY   0
 Signifies that this row in the flat file is currently empty and is okay to be overwritten. More...
 
#define ION_FLAT_FILE_SCAN_FORWARDS   1
 Signals to flat_file_scan to scan in a forward direction. More...
 
#define ION_FLAT_FILE_SCAN_BACKWARDS   0
 Signals to flat_file_scan to scan in a backward direction. More...
 

Typedefs

typedef ion_byte_t ion_flat_file_row_status_t
 This type describes the status flag within a flat file row. More...
 
typedef ion_boolean_t(* ion_flat_file_predicate_t) (ion_flat_file_t *, ion_flat_file_row_t *, va_list *args)
 The function signature of a flat file predicate, used in searches. More...
 

Macro Definition Documentation

#define ION_FLAT_FILE_SCAN_BACKWARDS   0

Signals to flat_file_scan to scan in a backward direction.

Definition at line 68 of file flat_file_types.h.

#define ION_FLAT_FILE_SCAN_FORWARDS   1

Signals to flat_file_scan to scan in a forward direction.

Definition at line 64 of file flat_file_types.h.

#define ION_FLAT_FILE_STATUS_EMPTY   0

Signifies that this row in the flat file is currently empty and is okay to be overwritten.

Definition at line 59 of file flat_file_types.h.

#define ION_FLAT_FILE_STATUS_OCCUPIED   1

Signifies that this row in the flat file is currently occupied and should not be overwritten.

Definition at line 55 of file flat_file_types.h.

Typedef Documentation

typedef ion_boolean_t(* ion_flat_file_predicate_t) (ion_flat_file_t *, ion_flat_file_row_t *, va_list *args)

The function signature of a flat file predicate, used in searches.

Definition at line 119 of file flat_file_types.h.

This type describes the status flag within a flat file row.

Definition at line 50 of file flat_file_types.h.