fs_utils.h

Go to the documentation of this file.

 
#ifndef __FS_UTILS_H__
#define __FS_UTILS_H__
 
#include "esp_log.h"
#include "esp_err.h"
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <stdbool.h>
#include <dirent.h>

 
#ifdef __cplusplus
extern "C" {
#endif

typedef FILE file_t;

typedef enum {
    FR_OK,               
    FR_EOF,              
    FR_DISK_ERR,         
    FR_NO_FILE,          
    FR_BUFFER_TOO_SMALL, 
    FR_INVALID_PARAM     
} f_result_t;

typedef enum {
    WRITE_OVERWRITE, 
    WRITE_APPEND,    
    READ,            
    BWRITE_OVERWRITE,
    BWRITE_APPEND,   
    BREAD            
} f_mode_t;

bool path_exists(const char* path);

bool dir_exists(const char* path);

bool file_exists(const char *path);

f_result_t dir_list(const char *path);

f_result_t file_open(
    file_t **const file,
    const char *path,
    f_mode_t mode
);

f_result_t file_close(file_t** file);

f_result_t file_remove(const char *path);

f_result_t file_writeline(
    file_t *const file,
    const char *const restrict str
);

f_result_t file_write(
    file_t *const file,
    const void *const restrict data,
    size_t sz,
    size_t n
);

f_result_t file_readline(
    file_t *const file,
    char *const restrict buf,
    size_t n
);

f_result_t file_read(
    file_t *const file,
    void *const restrict buf,
    size_t sz,
    size_t n
);
 
#ifdef __cplusplus
}
#endif
 // end of fs_utils group
 
#endif // __FS_UTILS_H__