istream-sized.h revision 422df9158f9e3a2d21060f0fee2a9588e925f20e
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#ifndef ISTREAM_SIZED_H
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#define ISTREAM_SIZED_H
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher
33396dc46ea52c18f47db1b5d590880806521005Sumit Bosestruct istream_sized_error_data {
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher /* Stream's current v_offset */
33396dc46ea52c18f47db1b5d590880806521005Sumit Bose uoff_t v_offset;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* How many more bytes are being added within this read() */
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose size_t new_bytes;
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose /* What's the original wanted size. */
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose uoff_t wanted_size;
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose /* TRUE if we're at EOF now */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher bool eof;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher};
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallaghertypedef const char *
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagheristream_sized_callback_t(const struct istream_sized_error_data *data,
e65df5b966b27e13283c65f59f99ac44781e0333Simo Sorce void *context);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
002f84aea86371aa079b867c0ec39396b97109d3Lukas Slebodnik/* Assume that input stream is exactly the given size. If the stream is too
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher small, fail with stream_errno=EPIPE. If stream is too large, fail with
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher stream_errno=EINVAL. */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct istream *i_stream_create_sized(struct istream *input, uoff_t size);
ccf340e56364851f2e5b75e52d3d63701b662954Lukas Slebodnikstruct istream *i_stream_create_sized_range(struct istream *input,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uoff_t offset, uoff_t size);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher/* Like i_stream_create_sized*(), but allow input stream's size to be larger. */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct istream *i_stream_create_min_sized(struct istream *input, uoff_t min_size);
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagherstruct istream *i_stream_create_min_sized_range(struct istream *input,
cc98edd9479d4622634a1275c98058916c14059aStephen Gallagher uoff_t offset, uoff_t min_size);
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher/* Same as i_stream_create_sized(), but set the error message via the
cc98edd9479d4622634a1275c98058916c14059aStephen Gallagher callback. */
d3da1c165cdb4c1ec126a8f4b6b544ca415b9d20Pavel Březinastruct istream *
d3da1c165cdb4c1ec126a8f4b6b544ca415b9d20Pavel Březinai_stream_create_sized_with_callback(struct istream *input, uoff_t size,
d3da1c165cdb4c1ec126a8f4b6b544ca415b9d20Pavel Březina istream_sized_callback_t *error_callback,
c481179da5d5b53ce16d8784c0bd2857ffc2f061Lukas Slebodnik void *context);
1183d29d87c5c7439cf2364b7d7324d4a13b6e35Stephen Gallagher#define i_stream_create_sized_with_callback(input, size, error_callback, context) \
002f84aea86371aa079b867c0ec39396b97109d3Lukas Slebodnik i_stream_create_sized_with_callback(input, size + \
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher CALLBACK_TYPECHECK(error_callback, \
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *(*)(const struct istream_sized_error_data *, typeof(context))), \
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher (istream_sized_callback_t *)error_callback, context)
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#endif
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher