fw_if_fs_backend.h

Go to the documentation of this file.

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

struct fw_fs_namespace_iface {
  ra8_err_t (*stat)(void* ctx, const char* path, fw_fs_stat_t* out);
  ra8_err_t (*listdir)(void*           ctx,
                       const char*     path,
                       uint32_t        max_entries,
                       fw_fs_list_fn_t callback,
                       void*           callback_ctx,
                       uint32_t*       out_count,
                       bool*           out_complete);
  ra8_err_t (*dir_open)(void* ctx, const char* path, void* directory_state, uint32_t state_bytes);
  ra8_err_t (*dir_next)(void*                 ctx,
                        void*                 directory_state,
                        fw_fs_dirent_value_t* out,
                        bool*                 out_entry);
  ra8_err_t (*dir_close)(void* ctx, void* directory_state);
  ra8_err_t (*mkdir)(void* ctx, const char* path);
  ra8_err_t (*unlink)(void* ctx, const char* path);
  ra8_err_t (*rmdir)(void* ctx, const char* path);
  ra8_err_t (*rename)(void* ctx, const char* old_path, const char* new_path, bool replace);
  ra8_err_t (*space)(void* ctx, fw_fs_space_t* out);
};

struct fw_fs_stream_iface {
  ra8_err_t (*open)(void*             ctx,
                    const char*       path,
                    fw_fs_open_mode_t mode,
                    void*             file_state,
                    uint32_t          state_bytes);
  ra8_err_t (*read)(void* ctx, void* file_state, uint8_t* dst, uint32_t cap, uint32_t* out_read);
  ra8_err_t (
    *write)(void* ctx, void* file_state, const uint8_t* src, uint32_t len, uint32_t* out_written);
  ra8_err_t (*seek)(void* ctx, void* file_state, uint64_t absolute_offset);
  ra8_err_t (*tell)(void* ctx, void* file_state, uint64_t* out_offset);
  ra8_err_t (*size)(void* ctx, void* file_state, uint64_t* out_size);
  ra8_err_t (*sync)(void* ctx, void* file_state);
  ra8_err_t (*close)(void* ctx, void* file_state);
};

struct fw_fs_transaction_iface {
  ra8_err_t (*begin)(void*                      ctx,
                     void*                      transaction_state,
                     uint32_t                   state_bytes,
                     const char*                destination,
                     fw_fs_transaction_policy_t policy);
  ra8_err_t (*write)(void*          ctx,
                     void*          transaction_state,
                     const uint8_t* src,
                     uint32_t       len,
                     uint32_t*      out_written);
  ra8_err_t (*seek)(void* ctx, void* transaction_state, uint64_t absolute_offset);
  ra8_err_t (*validate)(void*               ctx,
                        void*               transaction_state,
                        fw_fs_validate_fn_t validator,
                        void*               validator_ctx);
  ra8_err_t (*commit)(void* ctx, void* transaction_state, bool* out_published);
  ra8_err_t (*abort)(void* ctx, void* transaction_state);
};

[[nodiscard]] ra8_err_t fw_fs_bind(fw_fs_t*                         out,
                                   const fw_fs_namespace_iface_t*   namespace_iface,
                                   const fw_fs_stream_iface_t*      stream_iface,
                                   const fw_fs_transaction_iface_t* transaction_iface,
                                   void*                            ctx,
                                   const fw_fs_caps_t*              caps);
 
#ifdef __cplusplus
}
#endif