GNUnet  0.11.x
Data Fields
GNUNET_PQ_ResultSpec Struct Reference

Description of a DB result cell. More...

#include <gnunet_pq_lib.h>

Data Fields

GNUNET_PQ_ResultConverter conv
 What is the format of the result? More...
 
GNUNET_PQ_ResultCleanup cleaner
 Function to clean up result data, NULL if cleanup is not necessary. More...
 
void * cls
 Closure for conv and cleaner. More...
 
void * dst
 Destination for the data. More...
 
size_t dst_size
 Allowed size for the data, 0 for variable-size (in this case, the type of dst is a void ** and we need to allocate a buffer of the right size). More...
 
const char * fname
 Field name of the desired result. More...
 
size_t * result_size
 Where to store actual size of the result. More...
 
bool is_nullable
 True if NULL is allowed for a value in the database. More...
 
bool * is_null
 Points to a location where we should store "true" if the result found is NULL, and otherwise "false". More...
 

Detailed Description

Description of a DB result cell.

Definition at line 274 of file gnunet_pq_lib.h.

Field Documentation

◆ conv

GNUNET_PQ_ResultConverter GNUNET_PQ_ResultSpec::conv

What is the format of the result?

Definition at line 279 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_cleanup_result(), and GNUNET_PQ_extract_result().

◆ cleaner

GNUNET_PQ_ResultCleanup GNUNET_PQ_ResultSpec::cleaner

Function to clean up result data, NULL if cleanup is not necessary.

Definition at line 285 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_cleanup_result(), and GNUNET_PQ_extract_result().

◆ cls

void* GNUNET_PQ_ResultSpec::cls

Closure for conv and cleaner.

Definition at line 290 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result().

◆ dst

void* GNUNET_PQ_ResultSpec::dst

◆ dst_size

size_t GNUNET_PQ_ResultSpec::dst_size

Allowed size for the data, 0 for variable-size (in this case, the type of dst is a void ** and we need to allocate a buffer of the right size).

Definition at line 302 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result(), and GNUNET_PQ_result_spec_fixed_size().

◆ fname

const char* GNUNET_PQ_ResultSpec::fname

Field name of the desired result.

Definition at line 307 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result().

◆ result_size

size_t* GNUNET_PQ_ResultSpec::result_size

Where to store actual size of the result.

Definition at line 312 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result().

◆ is_nullable

bool GNUNET_PQ_ResultSpec::is_nullable

True if NULL is allowed for a value in the database.

Definition at line 317 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result(), and GNUNET_PQ_result_spec_allow_null().

◆ is_null

bool* GNUNET_PQ_ResultSpec::is_null

Points to a location where we should store "true" if the result found is NULL, and otherwise "false".

Only used if is_nullable is true.

Definition at line 325 of file gnunet_pq_lib.h.

Referenced by GNUNET_PQ_extract_result(), and GNUNET_PQ_result_spec_allow_null().


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