5.12.4 Output Streams¶
An output stream is used for writing output as a raw stream of bytes.
It is compatible with standard C FILE streams, but allows different functions to be provided for things like writing to a buffer or a socket.
-
struct SerdOutputStream¶
An output stream that receives bytes.
-
void *stream¶
Opaque parameter for functions.
-
SerdWriteFunc write¶
Write bytes to output.
-
SerdErrorFunc error¶
Stream error accessor.
-
SerdCloseFunc close¶
Close output.
-
void *stream¶
-
SerdOutputStream serd_open_output_stream(SerdWriteFunc write_func, SerdErrorFunc error_func, SerdCloseFunc close_func, void *stream)¶
Open a stream that writes to a provided function.
- Parameters
write_func – Function to write output.
error_func – Function used to detect errors.
close_func – Function to close the stream after writing is done.
stream – Opaque stream parameter for write_func and close_func.
- Returns
An opened output stream, or all zeros on error.
-
SerdOutputStream serd_open_output_buffer(SerdDynamicBuffer *buffer)¶
Open a stream that writes to a buffer.
The
bufferis owned by the caller, but will be reallocated using the buffer’s allocator as necessary. Note that the string in the buffer will not be null terminated until the stream is closed.- Parameters
buffer – Buffer to write output to.
- Returns
An opened output stream, or all zeros on error.
-
SerdOutputStream serd_open_output_file(const char *path)¶
Open a stream that writes to a file.
An arbitrary
FILE*can be used withserd_open_output_stream()as well, this convenience function opens the file properly for writing with serd, and sets flags for optimized I/O if possible.- Parameters
path – Path of file to open and write to.
-
SerdStatus serd_close_output(SerdOutputStream *output)¶
Close an output stream.
This will call the close function, and reset the stream internally so that no further writes can be made. For convenience, this is safe to call on NULL, and safe to call several times on the same output. Failure is returned in both of those cases.