5.12.1 Input Streams¶
An input stream is used for reading input as a raw stream of bytes.
It is compatible with standard C FILE streams, but allows different functions to be provided for things like reading from a buffer or a socket.
-
struct SerdInputStream¶
An input stream that produces bytes.
-
void *stream¶
Opaque parameter for functions.
-
SerdReadFunc read¶
Read bytes from input.
-
SerdErrorFunc error¶
Stream error accessor.
-
SerdCloseFunc close¶
Close input.
-
void *stream¶
-
SerdInputStream serd_open_input_stream(SerdReadFunc read_func, SerdErrorFunc error_func, SerdCloseFunc close_func, void *stream)¶
Open a stream that reads from a provided function.
- Parameters
read_func – Function to read input.
error_func – Function used to detect errors.
close_func – Function to close the stream after reading is done.
stream – Opaque stream parameter for functions.
- Returns
An opened input stream, or all zeros on error.
-
SerdInputStream serd_open_input_string(const char **position)¶
Open a stream that reads from a string.
The string pointer that position points to must remain valid until the stream is closed. This pointer serves as the internal stream state and will be mutated as the stream is used.
- Parameters
position – Pointer to a valid string pointer for use as stream state.
- Returns
An opened input stream, or all zeros on error.
-
SerdInputStream serd_open_input_file(const char *path)¶
Open a stream that reads from a file.
An arbitrary
FILE*can be used withserd_open_input_stream()as well, this convenience function opens the file properly for reading with serd, and sets flags for optimized I/O if possible.- Parameters
path – Path of file to open and read from.
-
SerdStatus serd_close_input(SerdInputStream *input)¶
Close an input stream.
This will call the close function, and reset the stream internally so that no further reads can be made. For convenience, this is safe to call on NULL, and safe to call several times on the same input.