BSL_SeqReader_t Struct Reference

Definition of a simple flat buffer iterator. More...

#include <UtilDefs_SeqReadWrite.h>

Collaboration diagram for BSL_SeqReader_t:

Data Fields
void *	user_data
	Context from the BPA.
int(*	read )(void *user_data, void *buf, size_t *size)
	Called to read a block of data from the source.
void(*	deinit )(void *user_data)
	Called to close this reader and free its resources.

Detailed Description

Definition of a simple flat buffer iterator.

Field Documentation

deinit

void(* BSL_SeqReader_t::deinit) (void *user_data)

Called to close this reader and free its resources.

This pointer must not be NULL.

Parameters

[in]

user_data

The context pointer.

read

int(* BSL_SeqReader_t::read) (void *user_data, void *buf, size_t *size)

Called to read a block of data from the source.

This pointer must not be NULL.

Parameters

[in]	user_data	The context pointer.
[out]	buf	The buffer to read into, which must be large enough to hold the initial value of size.
[in,out]	size	The input of the buffer size, and set to the actual size of data read upon completion.

Returns

Zero if successful.

---

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

• src/backend/UtilDefs_SeqReadWrite.h