stdx_io.h

home

STDX - IO (file I/O utility functions) Part of the STDX General Purpose C Library by marciovmf License: MIT https://github.com/marciovmf/stdx

Overview

Provides utility functions for reading and writing files.

How to compile

To compile the implementation define X_IMPL_IO in one source file before including this header.

To customize how this module allocates memory, define X_IO_ALLOC / X_IO_FREE before including.

Macro

X_IO_VERSION_MAJOR

#define X_IO_VERSION_MAJOR 1
Macro

X_IO_VERSION_MINOR

#define X_IO_VERSION_MINOR 0
Macro

X_IO_VERSION_PATCH

#define X_IO_VERSION_PATCH 0
Struct

XFile

typedef struct XFile_t XFile;
Function

x_io_open

X_IO_API XFile * x_io_open(
 const char *filename,
 const char *mode
);
Function

x_io_close

X_IO_API void x_io_close(XFile *file);
Function

x_io_read

X_IO_API size_t x_io_read(
 XFile *file,
 void *buffer,
 size_t size
);
Function

x_io_read_all

X_IO_API char * x_io_read_all(
 XFile *file,
 size_t *out_size
);
Function

x_io_read_text

X_IO_API char * x_io_read_text(
 const char *filename,
 size_t *out_size
);
Function

x_io_write

X_IO_API size_t x_io_write(
 XFile *file,
 const void *data,
 size_t size
);
Function

x_io_write_text

X_IO_API bool x_io_write_text(
 const char *filename,
 const char *text
);
Function

x_io_append_text

X_IO_API bool x_io_append_text(
 const char *filename,
 const char *text
);
Function

x_io_seek

X_IO_API bool x_io_seek(
 XFile *file,
 long offset,
 int32_t origin
);
Function

x_io_tell

X_IO_API long x_io_tell(XFile *file);
Function

x_io_rewind

X_IO_API bool x_io_rewind(XFile *file);
Function

x_io_flush

X_IO_API bool x_io_flush(XFile *file);
Function

x_io_eof

X_IO_API bool x_io_eof(XFile *file);
Function

x_io_error

X_IO_API bool x_io_error(XFile *file);
Function

x_io_clearerr

X_IO_API void x_io_clearerr(XFile *file);
Function

x_io_fileno

X_IO_API int32_t x_io_fileno(XFile *file);
Macro

X_IO_ALLOC

#define X_IO_ALLOC(sz) malloc(sz)
Macro

X_IO_FREE

#define X_IO_FREE(p) free(p)
Struct

XFile_t

struct XFile_t{
  FILE *fp;
};