blob: 7a57e484456eaa540d47d3d47dc3cad5bae5a638 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
* ostream.h
*
* Copyright (C) 2019 David Oberhollenzer <goliath@infraroot.at>
*/
#ifndef IO_OSTREAM_H
#define IO_OSTREAM_H
#include "sqfs/predef.h"
/**
* @struct ostream_t
*
* @extends sqfs_object_t
*
* @brief An append-only data stream.
*/
typedef struct ostream_t {
sqfs_object_t base;
/**
* @brief Append a block of data to an output stream.
*
* @param strm A pointer to an output stream.
* @param data A pointer to the data block to append. If NULL,
* synthesize a chunk of zero bytes.
* @param size The number of bytes to append.
*
* @return Zero on success, -1 on failure.
*/
int (*append)(struct ostream_t *strm, const void *data, size_t size);
/**
* @brief Process all pending, buffered data and flush it to disk.
*
* If the stream performs some kind of transformation (e.g. transparent
* data compression), flushing caues the wrapped format to insert a
* termination token. Only call this function when you are absolutely
* DONE appending data, shortly before destroying the stream.
*
* @param strm A pointer to an output stream.
*
* @return Zero on success, -1 on failure.
*/
int (*flush)(struct ostream_t *strm);
/**
* @brief Get the underlying filename of a output stream.
*
* @param strm The output stream to get the filename from.
*
* @return A string holding the underlying filename.
*/
const char *(*get_filename)(struct ostream_t *strm);
} ostream_t;
#endif /* IO_OSTREAM_H */
|
