fw_if_fs.h

Go to the documentation of this file.

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

[[nodiscard]] ra8_err_t fw_fs_path_validate(const fw_fs_caps_t* caps, const char* path);

[[nodiscard]] ra8_err_t fw_fs_get_caps(const fw_fs_t* fs, fw_fs_caps_t* out);

[[nodiscard]] ra8_err_t
fw_fs_stat(const fw_fs_namespace_t* names, const char* path, fw_fs_stat_t* out);

[[nodiscard]] ra8_err_t fw_fs_listdir(const fw_fs_namespace_t* names,
                                      const char*              path,
                                      uint32_t                 max_entries,
                                      fw_fs_list_fn_t          callback,
                                      void*                    callback_ctx,
                                      uint32_t*                out_count,
                                      bool*                    out_complete);

[[nodiscard]] ra8_err_t fw_fs_dir_open(const fw_fs_namespace_t* names,
                                       const char*              path,
                                       fw_fs_dir_t*             directory,
                                       void*                    workspace,
                                       uint32_t                 workspace_size);

[[nodiscard]] ra8_err_t
fw_fs_dir_next(fw_fs_dir_t* directory, fw_fs_dirent_value_t* out, bool* out_entry);

[[nodiscard]] ra8_err_t fw_fs_dir_close(fw_fs_dir_t* directory);

[[nodiscard]] ra8_err_t fw_fs_mkdir(const fw_fs_namespace_t* names, const char* path);

[[nodiscard]] ra8_err_t fw_fs_unlink(const fw_fs_namespace_t* names, const char* path);

[[nodiscard]] ra8_err_t fw_fs_rmdir(const fw_fs_namespace_t* names, const char* path);

[[nodiscard]] ra8_err_t fw_fs_rename(const fw_fs_namespace_t* names,
                                     const char*              old_path,
                                     const char*              new_path,
                                     bool                     replace);

[[nodiscard]] ra8_err_t fw_fs_space(const fw_fs_namespace_t* names, fw_fs_space_t* out);

[[nodiscard]] ra8_err_t fw_fs_open(const fw_fs_stream_port_t* streams,
                                   const char*                path,
                                   fw_fs_open_mode_t          mode,
                                   fw_fs_file_t*              file,
                                   void*                      workspace,
                                   uint32_t                   workspace_size);

[[nodiscard]] ra8_err_t
fw_fs_read(fw_fs_file_t* file, uint8_t* dst, uint32_t cap, uint32_t* out_read);

[[nodiscard]] ra8_err_t
fw_fs_write(fw_fs_file_t* file, const uint8_t* source, uint32_t length, uint32_t* out_written);

[[nodiscard]] ra8_err_t fw_fs_seek(fw_fs_file_t* file, uint64_t absolute_offset);

[[nodiscard]] ra8_err_t fw_fs_tell(fw_fs_file_t* file, uint64_t* out_offset);

[[nodiscard]] ra8_err_t fw_fs_file_size(fw_fs_file_t* file, uint64_t* out_size);

[[nodiscard]] ra8_err_t fw_fs_sync(fw_fs_file_t* file);

[[nodiscard]] ra8_err_t fw_fs_close(fw_fs_file_t* file);

[[nodiscard]] ra8_err_t fw_fs_transaction_begin(const fw_fs_transaction_port_t* port,
                                                const char*                     destination,
                                                fw_fs_transaction_policy_t      policy,
                                                fw_fs_transaction_t*            transaction,
                                                void*                           workspace,
                                                uint32_t                        workspace_size);

[[nodiscard]] ra8_err_t fw_fs_transaction_write(fw_fs_transaction_t* transaction,
                                                const uint8_t*       source,
                                                uint32_t             length,
                                                uint32_t*            out_written);

[[nodiscard]] ra8_err_t fw_fs_transaction_seek(fw_fs_transaction_t* transaction,
                                               uint64_t             absolute_offset);

[[nodiscard]] ra8_err_t fw_fs_transaction_validate(fw_fs_transaction_t* transaction,
                                                   fw_fs_validate_fn_t  validator,
                                                   void*                validator_ctx);

[[nodiscard]] ra8_err_t fw_fs_transaction_commit(fw_fs_transaction_t* transaction,
                                                 bool*                out_published);

[[nodiscard]] ra8_err_t fw_fs_transaction_abort(fw_fs_transaction_t* transaction);
 
#ifdef __cplusplus
}
#endif