BSL_SeqWriter_t Struct Reference

Definition of a sequential writer using callbacks. More...

#include <UtilDefs_SeqReadWrite.h>

Collaboration diagram for BSL_SeqWriter_t:

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

Detailed Description

Definition of a sequential writer using callbacks.

Field Documentation

deinit

void(* BSL_SeqWriter_t::deinit) (void *user_data)

Called to close this writer and free its resources.

This pointer must not be NULL.

Parameters

[in]

user_data

The context pointer.

Postcondition

The data written to the block is reflected in later reads and/or block metadata.

write

int(* BSL_SeqWriter_t::write) (void *user_data, const 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.
[in]	buf	The buffer to write from, with its size indicated by size.
	size	The input of the buffer size.

Returns

Zero if successful writing the entire size.

---

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

• src/backend/UtilDefs_SeqReadWrite.h