libnestegg  0.1git
Data Fields
nestegg_io Struct Reference

User supplied IO context. More...

#include <nestegg.h>

Data Fields

int(* read )(void *buffer, size_t length, void *userdata)
 User supplied read callback. More...
 
int(* seek )(int64_t offset, int whence, void *userdata)
 User supplied seek callback. More...
 
int64_t(* tell )(void *userdata)
 User supplied tell callback. More...
 
void * userdata
 User supplied pointer to be passed to the IO callbacks.
 

Detailed Description

User supplied IO context.

Field Documentation

◆ read

int(* nestegg_io::read) (void *buffer, size_t length, void *userdata)

User supplied read callback.

Parameters
bufferBuffer to read data into.
lengthLength of supplied buffer in bytes.
userdataThe userdata supplied by the user.
Return values
1Read succeeded.
0End of stream.
-1Error.

◆ seek

int(* nestegg_io::seek) (int64_t offset, int whence, void *userdata)

User supplied seek callback.

Parameters
offsetOffset within the stream to seek to.
whenceSeek direction. One of NESTEGG_SEEK_SET, NESTEGG_SEEK_CUR, or NESTEGG_SEEK_END.
userdataThe userdata supplied by the user.
Return values
0Seek succeeded.
-1Error.

◆ tell

int64_t(* nestegg_io::tell) (void *userdata)

User supplied tell callback.

Parameters
userdataThe userdata supplied by the user.
Returns
Current position within the stream.
Return values
-1Error.

The documentation for this struct was generated from the following file: