fplayer/fc_8h_source.html

#ifndef FPLAYER_FC_H

#define FPLAYER_FC_H


#include <stdint.h>


struct FC;


enum fc_mode_t {

    FC_MODE_READ,

    FC_MODE_WRITE,

};


struct FC* FC_open(const char* fp, enum fc_mode_t mode);


void FC_close(struct FC* fc);


uint32_t FC_read(struct FC* fc, uint32_t offset, uint32_t size, uint8_t* b);


uint32_t FC_readto(struct FC* fc,

                   uint32_t offset,

                   uint32_t size,

                   uint32_t maxCount,

                   uint8_t* b);


uint32_t

FC_write(struct FC* fc, uint32_t offset, uint32_t size, const uint8_t* b);


uint32_t FC_filesize(struct FC* fc);


#endif//FPLAYER_FC_H

FC_readto
uint32_t FC_readto(struct FC *fc, uint32_t offset, uint32_t size, uint32_t maxCount, uint8_t *b)
Reads up to the given number of bytes from the file controller starting at the given offset,...
Definition fc.c:58

FC_filesize
uint32_t FC_filesize(struct FC *fc)
Returns the size of the file backing the given file controller. This performs a seek to the end of th...
Definition fc.c:83

FC_open
struct FC * FC_open(const char *fp, enum fc_mode_t mode)
Opens a file controller instance for the given file path and mode.
Definition fc.c:16

FC_close
void FC_close(struct FC *fc)
Closes the given file controller instance and frees its resources.
Definition fc.c:39

FC_write
uint32_t FC_write(struct FC *fc, uint32_t offset, uint32_t size, const uint8_t *b)
Writes the given number of bytes to the file controller starting at the given offset.
Definition fc.c:71

FC_read
uint32_t FC_read(struct FC *fc, uint32_t offset, uint32_t size, uint8_t *b)
Reads the given number of bytes from the file controller starting at the given offset.
Definition fc.c:47

fc_mode_t
fc_mode_t
File controller open mode.
Definition fc.h:15

FC_MODE_WRITE
@ FC_MODE_WRITE
Equivalent to "wb".
Definition fc.h:17

FC_MODE_READ
@ FC_MODE_READ
Equivalent to "rb".
Definition fc.h:16

FC
File controller that wraps a stdlib file pointer and provides additional functionality for reading fi...
Definition fc.c:10

FC::fp
char * fp
Duplicate of filepath provided to FC_open.
Definition fc.c:11