ra8_io_vfs.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_fs.h"
#include "ra8_io_fsfmt.h"

typedef enum : uint8_t {
  k_ra8_io_vfs_max_mounts = 4,  
  k_ra8_io_vfs_max_files  = 4,  
  k_ra8_io_vfs_name_max   = 16, 
} ra8_io_vfs_limits_t;

typedef struct ra8_io_vfs_file ra8_io_vfs_file_t;

typedef struct {
  const ra8_io_fsfmt_t* format;      
  void*                 state;       
  uint32_t              state_bytes; 
  bool                  is_open;     
} ra8_io_vfs_dir_t;

typedef struct {
  uint64_t           size_bytes;   
  ra8_fs_timestamp_t created;      
  ra8_fs_timestamp_t modified;     
  ra8_fs_timestamp_t accessed;     
  uint8_t            attr;         
  bool               is_directory; 
  bool               exists;       
} ra8_io_vfs_stat_t;

[[nodiscard]] ra8_err_t ra8_io_vfs_init(void);

[[nodiscard]] ra8_err_t ra8_io_vfs_mount(const char* name, ra8_fs_mount_t* mount);

[[nodiscard]] ra8_err_t ra8_io_vfs_mount_auto(const char* name, const ra8_fs_backend_t* backend);

[[nodiscard]] ra8_err_t ra8_io_vfs_unmount(const char* name);

[[nodiscard]] ra8_err_t
ra8_io_vfs_open(const char* path, ra8_fs_mode_t mode, ra8_fs_file_t** out_file);

[[nodiscard]] ra8_err_t
ra8_io_vfs_file_open(const char* path, ra8_fs_mode_t mode, ra8_io_vfs_file_t** out_file);

[[nodiscard]] ra8_err_t ra8_io_vfs_file_close(ra8_io_vfs_file_t* file);

[[nodiscard]] ra8_err_t
ra8_io_vfs_file_read(ra8_io_vfs_file_t* file, void* buf, uint32_t bytes, uint32_t* out_read);

[[nodiscard]] ra8_err_t
ra8_io_vfs_file_write(ra8_io_vfs_file_t* file, const void* buf, uint32_t bytes);

[[nodiscard]] ra8_err_t ra8_io_vfs_file_seek(ra8_io_vfs_file_t* file, uint64_t offset_bytes);

[[nodiscard]] ra8_err_t ra8_io_vfs_file_tell(const ra8_io_vfs_file_t* file, uint64_t* out_offset);

[[nodiscard]] ra8_err_t ra8_io_vfs_file_size(const ra8_io_vfs_file_t* file, uint64_t* out_bytes);

[[nodiscard]] ra8_err_t ra8_io_vfs_file_sync(ra8_io_vfs_file_t* file);

[[nodiscard]] ra8_err_t ra8_io_vfs_unlink(const char* path);

[[nodiscard]] ra8_err_t ra8_io_vfs_rename(const char* old_path, const char* new_path);

[[nodiscard]] ra8_err_t ra8_io_vfs_stat(const char* path, ra8_io_vfs_stat_t* out);

[[nodiscard]] ra8_err_t ra8_io_vfs_get_caps(const char* name, ra8_io_fsfmt_caps_t* out);

[[nodiscard]] ra8_err_t ra8_io_vfs_free_space(const char* name, ra8_fs_space_t* out);

[[nodiscard]] ra8_err_t ra8_io_vfs_listdir(const char* path, ra8_fs_listdir_cb_t cb, void* ctx);

[[nodiscard]] ra8_err_t ra8_io_vfs_dir_requirements(const char* path,
                                                    uint32_t*   out_bytes,
                                                    uint8_t*    out_align,
                                                    uint16_t*   out_max_open);

[[nodiscard]] ra8_err_t ra8_io_vfs_dir_open(const char*       path,
                                            ra8_io_vfs_dir_t* directory,
                                            void*             workspace,
                                            uint32_t          workspace_bytes);

[[nodiscard]] ra8_err_t
ra8_io_vfs_dir_next(ra8_io_vfs_dir_t* directory, ra8_fs_dirent_t* out, bool* out_entry);

[[nodiscard]] ra8_err_t ra8_io_vfs_dir_close(ra8_io_vfs_dir_t* directory);

[[nodiscard]] ra8_err_t ra8_io_vfs_mkdir(const char* path);

[[nodiscard]] ra8_err_t ra8_io_vfs_rmdir(const char* path);
 
#ifdef __cplusplus
}
#endif