aboutsummaryrefslogtreecommitdiffstats
path: root/serd/serd.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2016-03-15 23:21:34 -0400
committerDavid Robillard <d@drobilla.net>2018-05-27 18:18:30 +0200
commit9b3d8263604ba11ae008c8651a1fe2063296d6b1 (patch)
tree9747d428f34f73e5d2e9e72bd8edef50b05ddad9 /serd/serd.h
parenta0c483d9f1f3955499560ef1536fdb760df274fb (diff)
downloadserd-9b3d8263604ba11ae008c8651a1fe2063296d6b1.tar.gz
serd-9b3d8263604ba11ae008c8651a1fe2063296d6b1.tar.bz2
serd-9b3d8263604ba11ae008c8651a1fe2063296d6b1.zip
Use SerdBuffer for mutable buffers
This avoids const violations from abusing SerdChunk as a mutable buffer for string sinks.
Diffstat (limited to 'serd/serd.h')
-rw-r--r--serd/serd.h20
1 files changed, 14 insertions, 6 deletions
diff --git a/serd/serd.h b/serd/serd.h
index b3056239..49ee3c3a 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -231,6 +231,14 @@ typedef struct {
} SerdChunk;
/**
+ A mutable buffer in memory.
+*/
+typedef struct {
+ void* buf; /**< Buffer */
+ size_t len; /**< Size of buffer in bytes */
+} SerdBuffer;
+
+/**
An error description.
*/
typedef struct {
@@ -955,24 +963,24 @@ serd_file_sink(const void* buf, size_t len, void* stream);
/**
A convenience sink function for writing to a string.
- This function can be used as a SerdSink to write to a SerdChunk which is
+ This function can be used as a SerdSink to write to a SerdBuffer which is
resized as necessary with realloc(). The `stream` parameter must point to
- an initialized SerdChunk. When the write is finished, the string should be
- retrieved with serd_chunk_sink_finish().
+ an initialized SerdBuffer. When the write is finished, the string should be
+ retrieved with serd_buffer_sink_finish().
*/
SERD_API
size_t
-serd_chunk_sink(const void* buf, size_t len, void* stream);
+serd_buffer_sink(const void* buf, size_t len, void* stream);
/**
- Finish a serialisation to a chunk with serd_chunk_sink().
+ Finish a serialisation to a chunk with serd_buffer_sink().
The returned string is the result of the serialisation, which is NULL
terminated (by this function) and owned by the caller.
*/
SERD_API
uint8_t*
-serd_chunk_sink_finish(SerdChunk* stream);
+serd_buffer_sink_finish(SerdBuffer* stream);
/**
Set a function to be called when errors occur during writing.