Filesystem File Producers

Functions
bool	sbufFSFileIn (StreamBuffer *sb, FSFile *file, bool close)
bool	sbufFSFilePRegisterPull (StreamBuffer *sb, FSFile *file, bool close)

Detailed Description

Functions for using low-level filesystem files as stream buffer data sources.

Function Documentation

sbufFSFileIn()

bool sbufFSFileIn	(	StreamBuffer *	sb,
		FSFile *	file,
		bool	close
	)

bool sbufFSFileIn(StreamBuffer *sb, FSFile *file, bool close)

Reads a filesystem file and pushes its entire contents into a stream buffer.

Automatically chunks the data based on the stream buffer's target size for efficient operation. The stream buffer is automatically finished after all data is read.

IMPORTANT: The stream buffer is invalidated after this call.

Parameters

sb	The stream buffer (invalidated after call)
file	Filesystem file to read from (optionally closed based on close parameter)
close	If true, the file is closed after reading

Returns

true on success, false on error

Example:

FSFile *file = fsOpen(_S"data.bin", FS_Read, 0);
StreamBuffer *sb = sbufCreate(4096);
sbufStrCRegisterPush(sb, &output);
sbufFSFileIn(sb, file, true);  // file is closed automatically

sbufFSFilePRegisterPull()

bool sbufFSFilePRegisterPull	(	StreamBuffer *	sb,
		FSFile *	file,
		bool	close
	)

bool sbufFSFilePRegisterPull(StreamBuffer *sb, FSFile *file, bool close)

Registers a filesystem file as a producer with the stream buffer in pull mode.

In pull mode, the consumer pulls data as needed, and the file is read in chunks on demand. Use this instead of sbufFSFileIn() when you need finer control over when data is read.

Parameters

sb	The stream buffer
file	Filesystem file to read from (optionally closed when producer finishes)
close	If true, the file is closed when the producer finishes

Returns

true on success, false if registration failed