storage.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include "filesystem_api_defines.h"
#include "storage_sd_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define STORAGE_INT_PATH_PREFIX        "/int"
#define STORAGE_EXT_PATH_PREFIX        "/ext"
#define STORAGE_ANY_PATH_PREFIX        "/any"
#define STORAGE_APP_DATA_PATH_PREFIX   "/data"
#define STORAGE_APP_ASSETS_PATH_PREFIX "/assets"
 
#define INT_PATH(path)        STORAGE_INT_PATH_PREFIX "/" path
#define EXT_PATH(path)        STORAGE_EXT_PATH_PREFIX "/" path
#define ANY_PATH(path)        STORAGE_ANY_PATH_PREFIX "/" path
#define APP_DATA_PATH(path)   STORAGE_APP_DATA_PATH_PREFIX "/" path
#define APP_ASSETS_PATH(path) STORAGE_APP_ASSETS_PATH_PREFIX "/" path
 
#define RECORD_STORAGE "storage"
 
typedef struct Storage Storage;
 
File* storage_file_alloc(Storage* storage);
 
void storage_file_free(File* file);
 
typedef enum {
    StorageEventTypeCardMount, 
    StorageEventTypeCardUnmount, 
    StorageEventTypeCardMountError, 
    StorageEventTypeFileClose, 
    StorageEventTypeDirClose, 
} StorageEventType;
 
typedef struct {
    StorageEventType type; 
} StorageEvent;
 
FuriPubSub* storage_get_pubsub(Storage* storage);
 
/******************* File Functions *******************/
 
bool storage_file_open(
    File* file,
    const char* path,
    FS_AccessMode access_mode,
    FS_OpenMode open_mode);
 
bool storage_file_close(File* file);
 
bool storage_file_is_open(File* file);
 
bool storage_file_is_dir(File* file);
 
size_t storage_file_read(File* file, void* buff, size_t bytes_to_read);
 
size_t storage_file_write(File* file, const void* buff, size_t bytes_to_write);
 
bool storage_file_seek(File* file, uint32_t offset, bool from_start);
 
uint64_t storage_file_tell(File* file);
 
bool storage_file_truncate(File* file);
 
uint64_t storage_file_size(File* file);
 
bool storage_file_sync(File* file);
 
bool storage_file_eof(File* file);
 
bool storage_file_exists(Storage* storage, const char* path);
 
bool storage_file_copy_to_file(File* source, File* destination, size_t size);
 
/******************* Directory Functions *******************/
 
bool storage_dir_open(File* file, const char* path);
 
bool storage_dir_close(File* file);
 
bool storage_dir_read(File* file, FileInfo* fileinfo, char* name, uint16_t name_length);
 
bool storage_dir_rewind(File* file);
 
bool storage_dir_exists(Storage* storage, const char* path);
 
/******************* Common Functions *******************/
 
FS_Error storage_common_timestamp(Storage* storage, const char* path, uint32_t* timestamp);
 
FS_Error storage_common_stat(Storage* storage, const char* path, FileInfo* fileinfo);
 
FS_Error storage_common_remove(Storage* storage, const char* path);
 
FS_Error storage_common_rename(Storage* storage, const char* old_path, const char* new_path);
 
FS_Error storage_common_copy(Storage* storage, const char* old_path, const char* new_path);
 
FS_Error storage_common_merge(Storage* storage, const char* old_path, const char* new_path);
 
FS_Error storage_common_mkdir(Storage* storage, const char* path);
 
FS_Error storage_common_fs_info(
    Storage* storage,
    const char* fs_path,
    uint64_t* total_space,
    uint64_t* free_space);
 
void storage_common_resolve_path_and_ensure_app_directory(Storage* storage, FuriString* path);
 
FS_Error storage_common_migrate(Storage* storage, const char* source, const char* dest);
 
bool storage_common_exists(Storage* storage, const char* path);
 
bool storage_common_equivalent_path(Storage* storage, const char* path1, const char* path2);
 
bool storage_common_is_subdir(Storage* storage, const char* parent, const char* child);
 
/******************* Error Functions *******************/
 
const char* storage_error_get_desc(FS_Error error_id);
 
FS_Error storage_file_get_error(File* file);
 
int32_t storage_file_get_internal_error(File* file);
 
const char* storage_file_get_error_desc(File* file);
 
/******************* SD Card Functions *******************/
 
FS_Error storage_sd_format(Storage* storage);
 
FS_Error storage_sd_unmount(Storage* storage);
 
FS_Error storage_sd_mount(Storage* storage);
 
FS_Error storage_sd_info(Storage* storage, SDInfo* info);
 
FS_Error storage_sd_status(Storage* storage);
 
/************ Internal Storage Backup/Restore ************/
 
typedef void (*StorageNameConverter)(FuriString*);
 
FS_Error storage_int_backup(Storage* storage, const char* dstname);
 
FS_Error
    storage_int_restore(Storage* storage, const char* dstname, StorageNameConverter converter);
 
/***************** Simplified Functions ******************/
 
bool storage_simply_remove(Storage* storage, const char* path);
 
bool storage_simply_remove_recursive(Storage* storage, const char* path);
 
bool storage_simply_mkdir(Storage* storage, const char* path);
 
void storage_get_next_filename(
    Storage* storage,
    const char* dirname,
    const char* filename,
    const char* fileextension,
    FuriString* nextfilename,
    uint8_t max_len);
 
#ifdef __cplusplus
}
#endif