APIs for working with storages, directories and files. More...

#include <stdint.h>
#include "filesystem_api_defines.h"
#include "storage_sd_api.h"

Data Structures
struct	StorageEvent
	Storage event (passed to the PubSub callback). More...

Macros
#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)

#define	EXT_PATH(path)

#define	ANY_PATH(path)

#define	APP_DATA_PATH(path)

#define	APP_ASSETS_PATH(path)

#define	RECORD_STORAGE "storage"

Typedefs
typedef struct Storage	Storage

typedef void(*	StorageNameConverter) (FuriString *)

Enumerations
enum	StorageEventType { StorageEventTypeCardMount , StorageEventTypeCardUnmount , StorageEventTypeCardMountError , StorageEventTypeFileClose , StorageEventTypeDirClose }
	Enumeration of events emitted by the storage through the PubSub system. More...

Functions
File *	storage_file_alloc (Storage *storage)
	Allocate and initialize a file instance.

void	storage_file_free (File *file)
	Free the file instance.

FuriPubSub *	storage_get_pubsub (Storage *storage)
	Get the storage pubsub instance.

bool	storage_file_open (File file, const char path, FS_AccessMode access_mode, FS_OpenMode open_mode)
	Open an existing file or create a new one.

bool	storage_file_close (File *file)
	Close the file.

bool	storage_file_is_open (File *file)
	Check whether the file is open.

bool	storage_file_is_dir (File *file)
	Check whether a file instance represents a directory.

size_t	storage_file_read (File file, void buff, size_t bytes_to_read)
	Read bytes from a file into a buffer.

size_t	storage_file_write (File file, const void buff, size_t bytes_to_write)
	Write bytes from a buffer to a file.

bool	storage_file_seek (File *file, uint32_t offset, bool from_start)
	Change the current access position in a file.

uint64_t	storage_file_tell (File *file)
	Get the current access position.

bool	storage_file_truncate (File *file)
	Truncate the file size to the current access position.

uint64_t	storage_file_size (File *file)
	Get the file size.

bool	storage_file_sync (File *file)
	Synchronise the file cache with the actual storage.

bool	storage_file_eof (File *file)
	Check whether the current access position is at the end of the file.

bool	storage_file_exists (Storage storage, const char path)
	Check whether a file exists.

bool	storage_file_copy_to_file (File source, File destination, size_t size)
	Copy data from a source file to the destination file.

bool	storage_dir_open (File file, const char path)
	Open a directory.

bool	storage_dir_close (File *file)
	Close the directory.

bool	storage_dir_read (File file, FileInfo fileinfo, char *name, uint16_t name_length)
	Get the next item in the directory.

bool	storage_dir_rewind (File *file)
	Change the access position to first item in the directory.

bool	storage_dir_exists (Storage storage, const char path)
	Check whether a directory exists.

FS_Error	storage_common_timestamp (Storage storage, const char path, uint32_t *timestamp)
	Get the last access time in UNIX format.

FS_Error	storage_common_stat (Storage storage, const char path, FileInfo *fileinfo)
	Get information about a file or a directory.

FS_Error	storage_common_remove (Storage storage, const char path)
	Remove a file or a directory.

FS_Error	storage_common_rename (Storage storage, const char old_path, const char *new_path)
	Rename a file or a directory.

FS_Error	storage_common_copy (Storage storage, const char old_path, const char *new_path)
	Copy the file to a new location.

FS_Error	storage_common_merge (Storage storage, const char old_path, const char *new_path)
	Copy the contents of one directory into another and rename all conflicting files.

FS_Error	storage_common_mkdir (Storage storage, const char path)
	Create a directory.

FS_Error	storage_common_fs_info (Storage storage, const char fs_path, uint64_t total_space, uint64_t free_space)
	Get the general information about the storage.

void	storage_common_resolve_path_and_ensure_app_directory (Storage storage, FuriString path)
	Parse aliases in a path and replace them with the real path.

FS_Error	storage_common_migrate (Storage storage, const char source, const char *dest)
	Move the contents of source folder to destination one and rename all conflicting files.

bool	storage_common_exists (Storage storage, const char path)
	Check whether a file or a directory exists.

bool	storage_common_equivalent_path (Storage storage, const char path1, const char *path2)
	Check whether two paths are equivalent.

bool	storage_common_is_subdir (Storage storage, const char parent, const char *child)
	Check whether a path is a subpath of another path.

const char *	storage_error_get_desc (FS_Error error_id)
	Get the textual description of a numeric error identifer.

FS_Error	storage_file_get_error (File *file)
	Get the numeric error identifier from a file instance.

int32_t	storage_file_get_internal_error (File *file)
	Get the internal (storage-specific) numeric error identifier from a file instance.

const char *	storage_file_get_error_desc (File *file)
	Get the textual description of a the last error associated with a file instance.

FS_Error	storage_sd_format (Storage *storage)
	Format the SD Card.

FS_Error	storage_sd_unmount (Storage *storage)
	Unmount the SD card.

FS_Error	storage_sd_mount (Storage *storage)
	Mount the SD card.

FS_Error	storage_sd_info (Storage storage, SDInfo info)
	Get SD card information.

FS_Error	storage_sd_status (Storage *storage)
	Get SD card status.

FS_Error	storage_int_backup (Storage storage, const char dstname)
	Back up the internal storage contents to a *.tar archive.

FS_Error	storage_int_restore (Storage storage, const char dstname, StorageNameConverter converter)
	Restore the internal storage contents from a *.tar archive.

bool	storage_simply_remove (Storage storage, const char path)
	Remove a file or a directory.

bool	storage_simply_remove_recursive (Storage storage, const char path)
	Recursively remove a file or a directory.

bool	storage_simply_mkdir (Storage storage, const char path)
	Create a directory.

void	storage_get_next_filename (Storage storage, const char dirname, const char filename, const char fileextension, FuriString *nextfilename, uint8_t max_len)
	Get the next free filename in a directory.

Detailed Description

APIs for working with storages, directories and files.

Macro Definition Documentation

◆ ANY_PATH

#define ANY_PATH ( path )

Value:

STORAGE_ANY_PATH_PREFIX "/" path

◆ APP_ASSETS_PATH

#define APP_ASSETS_PATH ( path )

Value:

STORAGE_APP_ASSETS_PATH_PREFIX "/" path

◆ APP_DATA_PATH

#define APP_DATA_PATH ( path )

Value:

STORAGE_APP_DATA_PATH_PREFIX "/" path

◆ EXT_PATH

#define EXT_PATH ( path )

Value:

STORAGE_EXT_PATH_PREFIX "/" path

◆ INT_PATH

#define INT_PATH ( path )

Value:

STORAGE_INT_PATH_PREFIX "/" path

Enumeration Type Documentation

◆ StorageEventType

enum StorageEventType

Enumeration of events emitted by the storage through the PubSub system.

Enumerator
StorageEventTypeCardMount	SD card was mounted.
StorageEventTypeCardUnmount	SD card was unmounted.
StorageEventTypeCardMountError	An error occurred during mounting of an SD card.
StorageEventTypeFileClose	A file was closed.
StorageEventTypeDirClose	A directory was closed.

Function Documentation

◆ storage_common_copy()

FS_Error storage_common_copy	(	Storage *	storage,
		const char *	old_path,
		const char *	new_path )

Copy the file to a new location.

The file must NOT be open at the time of calling this function.

Parameters

storage	pointer to a storage API instance.
old_path	pointer to a zero-terminated string containing the source path.
new_path	pointer to a zero-terminated string containing the destination path.

Returns: FSE_OK if the file has been successfully copied, any other error code on failure.

◆ storage_common_equivalent_path()

bool storage_common_equivalent_path	(	Storage *	storage,
		const char *	path1,
		const char *	path2 )

Check whether two paths are equivalent.

This function will resolve aliases and apply filesystem-specific rules to determine whether the two given paths are equivalent.

Examples:

/int/text and /ext/test -> false (Different storages),
/int/Test and /int/test -> false (Case-sensitive storage),
/ext/Test and /ext/test -> true (Case-insensitive storage).

Parameters

storage	pointer to a storage API instance.
path1	pointer to a zero-terminated string containing the first path.
path2	pointer to a zero-terminated string containing the second path.

Returns: true if paths are equivalent, false otherwise.

◆ storage_common_exists()

bool storage_common_exists	(	Storage *	storage,
		const char *	path )

Check whether a file or a directory exists.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path in question.

Returns: true if a file or a directory exists, false otherwise.

◆ storage_common_fs_info()

FS_Error storage_common_fs_info	(	Storage *	storage,
		const char *	fs_path,
		uint64_t *	total_space,
		uint64_t *	free_space )

Get the general information about the storage.

Parameters

storage	pointer to a storage API instance.
fs_path	pointer to a zero-terminated string containing the path to the storage question.
total_space	pointer to the value to contain the total capacity, in bytes.
free_space	pointer to the value to contain the available space, in bytes.

Returns: FSE_OK if the information has been successfully received, any other error code on failure.

◆ storage_common_is_subdir()

bool storage_common_is_subdir	(	Storage *	storage,
		const char *	parent,
		const char *	child )

Check whether a path is a subpath of another path.

This function respects storage-defined equivalence rules (see storage_common_equivalent_path).

Parameters

storage	pointer to a storage API instance.
parent	pointer to a zero-terminated string containing the parent path.
child	pointer to a zero-terminated string containing the child path.

Returns: true if child is a subpath of parent, or if child is equivalent to parent; false otherwise.

◆ storage_common_merge()

FS_Error storage_common_merge	(	Storage *	storage,
		const char *	old_path,
		const char *	new_path )

Copy the contents of one directory into another and rename all conflicting files.

Parameters

storage	pointer to a storage API instance.
old_path	pointer to a zero-terminated string containing the source path.
new_path	pointer to a zero-terminated string containing the destination path.

Returns: FSE_OK if the directories have been successfully merged, any other error code on failure.

◆ storage_common_migrate()

FS_Error storage_common_migrate	(	Storage *	storage,
		const char *	source,
		const char *	dest )

Move the contents of source folder to destination one and rename all conflicting files.

Source folder will be deleted if the migration was successful.

Parameters

storage	pointer to a storage API instance.
source	pointer to a zero-terminated string containing the source path.
dest	pointer to a zero-terminated string containing the destination path.

Returns: FSE_OK if the migration was successfull completed, any other error code on failure.

◆ storage_common_mkdir()

FS_Error storage_common_mkdir	(	Storage *	storage,
		const char *	path )

Create a directory.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the directory path.

Returns: FSE_OK if the directory has been successfully created, any other error code on failure.

◆ storage_common_remove()

FS_Error storage_common_remove	(	Storage *	storage,
		const char *	path )

Remove a file or a directory.

The directory must be empty. The file or the directory must NOT be open.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path of the item to be removed.

Returns: FSE_OK if the file or directory has been successfully removed, any other error code on failure.

◆ storage_common_rename()

FS_Error storage_common_rename	(	Storage *	storage,
		const char *	old_path,
		const char *	new_path )

Rename a file or a directory.

The file or the directory must NOT be open. Will overwrite the destination file if it already exists.

Renaming a regular file to itself does nothing and always succeeds. Renaming a directory to itself or to a subdirectory of itself always fails.

Parameters

storage	pointer to a storage API instance.
old_path	pointer to a zero-terminated string containing the source path.
new_path	pointer to a zero-terminated string containing the destination path.

Returns: FSE_OK if the file or directory has been successfully renamed, any other error code on failure.

◆ storage_common_resolve_path_and_ensure_app_directory()

void storage_common_resolve_path_and_ensure_app_directory	(	Storage *	storage,
		FuriString *	path )

Parse aliases in a path and replace them with the real path.

Necessary special directories will be created automatically if they did not exist.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path in question.

◆ storage_common_stat()

FS_Error storage_common_stat	(	Storage *	storage,
		const char *	path,
		FileInfo *	fileinfo )

Get information about a file or a directory.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path of the item in question.
fileinfo	pointer to the FileInfo structure to contain the info (may be NULL).

Returns: FSE_OK if the info has been successfully received, any other error code on failure.

◆ storage_common_timestamp()

FS_Error storage_common_timestamp	(	Storage *	storage,
		const char *	path,
		uint32_t *	timestamp )

Get the last access time in UNIX format.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path of the item in question.
timestamp	pointer to a value to contain the timestamp.

Returns: FSE_OK if the timestamp has been successfully received, any other error code on failure.

◆ storage_dir_close()

bool storage_dir_close ( File * file )

Close the directory.

Parameters

file	pointer to a file instance representing the directory in question.

Returns: true if the directory was successfully closed, false otherwise.

◆ storage_dir_exists()

bool storage_dir_exists	(	Storage *	storage,
		const char *	path )

Check whether a directory exists.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path of the directory in question.

Returns: true if the directory exists, false otherwise.

◆ storage_dir_open()

bool storage_dir_open	(	File *	file,
		const char *	path )

Open a directory.

Opening a directory is necessary to be able to read its contents with storage_dir_read().

Warning: The calling code MUST call storage_dir_close() even if the open operation had failed.

Parameters

file	pointer to a file instance representing the directory in question.
path	pointer to a zero-terminated string containing the path of the directory in question.

Returns: true if the directory was successfully opened, false otherwise.

◆ storage_dir_read()

bool storage_dir_read	(	File *	file,
		FileInfo *	fileinfo,
		char *	name,
		uint16_t	name_length )

Get the next item in the directory.

If the next object does not exist, this function returns false as well and sets the file error id to FSE_NOT_EXIST.

Parameters

file	pointer to a file instance representing the directory in question.
fileinfo	pointer to the FileInfo structure to contain the info (may be NULL).
name	pointer to the buffer to contain the name (may be NULL).
name_length	maximum capacity of the name buffer, in bytes.

Returns: true if the next item was successfully read, false otherwise.

◆ storage_dir_rewind()

bool storage_dir_rewind ( File * file )

Change the access position to first item in the directory.

Parameters

file	pointer to a file instance representing the directory in question.

Returns: true if the access position was successfully changed, false otherwise.

◆ storage_error_get_desc()

const char * storage_error_get_desc ( FS_Error error_id )

Get the textual description of a numeric error identifer.

Parameters

error_id numeric identifier of the error in question.

Returns: pointer to a statically allocated zero-terminated string containing the respective error text.

◆ storage_file_alloc()

File * storage_file_alloc ( Storage * storage )

Allocate and initialize a file instance.

Parameters

storage pointer to a storage API instance.

Returns: pointer to the created instance.

◆ storage_file_close()

bool storage_file_close ( File * file )

Close the file.

Parameters

file	pointer to the file instance to be closed.

Returns: true if the file was successfully closed, false otherwise.

◆ storage_file_copy_to_file()

bool storage_file_copy_to_file	(	File *	source,
		File *	destination,
		size_t	size )

Copy data from a source file to the destination file.

Both files must be opened prior to calling this function.

The requested amount of bytes will be copied from the current access position in the source file to the current access position in the destination file.

Parameters

source	pointer to a source file instance.
destination	pointer to a destination file instance.
size	data size to be copied, in bytes.

Returns: true if the data was successfully copied, false otherwise.

◆ storage_file_eof()

bool storage_file_eof ( File * file )

Check whether the current access position is at the end of the file.

Parameters

file	pointer to a file instance in question.

Returns: bool true if the current access position is at the end of the file, false otherwise.

◆ storage_file_exists()

bool storage_file_exists	(	Storage *	storage,
		const char *	path )

Check whether a file exists.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the path to the file in question.

Returns: true if the file exists, false otherwise.

◆ storage_file_free()

void storage_file_free ( File * file )

Free the file instance.

If the file was open, calling this function will close it automatically.

Parameters

file	pointer to the file instance to be freed.

◆ storage_file_get_error()

FS_Error storage_file_get_error ( File * file )

Get the numeric error identifier from a file instance.

Warning: It is not possible to get the error identifier after the file has been closed.

Parameters

file	pointer to the file instance in question (must NOT be NULL).

Returns: numeric identifier of the last error associated with the file instance.

◆ storage_file_get_error_desc()

const char * storage_file_get_error_desc ( File * file )

Get the textual description of a the last error associated with a file instance.

Warning: It is not possible to get the error text after the file has been closed.

Parameters

file	pointer to the file instance in question (must NOT be NULL).

Returns: pointer to a statically allocated zero-terminated string containing the respective error text.

◆ storage_file_get_internal_error()

int32_t storage_file_get_internal_error ( File * file )

Get the internal (storage-specific) numeric error identifier from a file instance.

Warning: It is not possible to get the internal error identifier after the file has been closed.

Parameters

file	pointer to the file instance in question (must NOT be NULL).

Returns: numeric identifier of the last internal error associated with the file instance.

◆ storage_file_is_dir()

bool storage_file_is_dir ( File * file )

Check whether a file instance represents a directory.

Parameters

file	pointer to the file instance in question.

Returns: true if the file instance represents a directory, false otherwise.

◆ storage_file_is_open()

bool storage_file_is_open ( File * file )

Check whether the file is open.

Parameters

file	pointer to the file instance in question.

Returns: true if the file is open, false otherwise.

◆ storage_file_open()

bool storage_file_open	(	File *	file,
		const char *	path,
		FS_AccessMode	access_mode,
		FS_OpenMode	open_mode )

Open an existing file or create a new one.

Warning: The calling code MUST call storage_file_close() even if the open operation had failed.

Parameters

file	pointer to the file instance to be opened.
path	pointer to a zero-terminated string containing the path to the file to be opened.
access_mode	access mode from FS_AccessMode.
open_mode	open mode from FS_OpenMode

Returns: true if the file was successfully opened, false otherwise.

◆ storage_file_read()

size_t storage_file_read	(	File *	file,
		void *	buff,
		size_t	bytes_to_read )

Read bytes from a file into a buffer.

Parameters

file	pointer to the file instance to read from.
buff	pointer to the buffer to be filled with read data.
bytes_to_read	number of bytes to read. Must be less than or equal to the size of the buffer.

Returns: actual number of bytes read (may be fewer than requested).

◆ storage_file_seek()

bool storage_file_seek	(	File *	file,
		uint32_t	offset,
		bool	from_start )

Change the current access position in a file.

Parameters

file	pointer to the file instance in question.
offset	access position offset (meaning depends on from_start parameter).
from_start	if true, set the access position relative to the file start, otherwise relative to the current position.

Returns: success flag

◆ storage_file_size()

uint64_t storage_file_size ( File * file )

Get the file size.

Parameters

file	pointer to the file instance in question.

Returns: size of the file, in bytes.

◆ storage_file_sync()

bool storage_file_sync ( File * file )

Synchronise the file cache with the actual storage.

Parameters

file	pointer to the file instance in question.

Returns: true if the file was successfully synchronised, false otherwise.

◆ storage_file_tell()

uint64_t storage_file_tell ( File * file )

Get the current access position.

Parameters

file	pointer to the file instance in question.

Returns: current access position.

◆ storage_file_truncate()

bool storage_file_truncate ( File * file )

Truncate the file size to the current access position.

Parameters

file	pointer to the file instance to be truncated.

Returns: true if the file was successfully truncated, false otherwise.

◆ storage_file_write()

size_t storage_file_write	(	File *	file,
		const void *	buff,
		size_t	bytes_to_write )

Write bytes from a buffer to a file.

Parameters

file	pointer to the file instance to write into.
buff	pointer to the buffer containing the data to be written.
bytes_to_write	number of bytes to write. Must be less than or equal to the size of the buffer.

Returns: actual number of bytes written (may be fewer than requested).

◆ storage_get_next_filename()

void storage_get_next_filename	(	Storage *	storage,
		const char *	dirname,
		const char *	filename,
		const char *	fileextension,
		FuriString *	nextfilename,
		uint8_t	max_len )

Get the next free filename in a directory.

Usage example:

FuriString* file_name = furi_string_alloc();
Storage* storage = furi_record_open(RECORD_STORAGE);
 
storage_get_next_filename(storage,
    "/ext/test",
    "cookies",
    ".yum",
    20);
 
furi_record_close(RECORD_STORAGE);
 
use_file_name(file_name);
 
furi_string_free(file_name);

Possible file_name values after calling storage_get_next_filename(): "cookies", "cookies1", "cookies2", ... etc depending on whether any of these files have already existed in the directory.

Note: If the resulting next file name length is greater than set by the max_len parameter, the original filename will be returned instead.

Parameters

storage	pointer to a storage API instance.
dirname	pointer to a zero-terminated string containing the directory path.
filename	pointer to a zero-terminated string containing the file name.
fileextension	pointer to a zero-terminated string containing the file extension.
nextfilename	pointer to a dynamic string containing the resulting file name.
max_len	maximum length of the new name.

◆ storage_get_pubsub()

FuriPubSub * storage_get_pubsub ( Storage * storage )

Get the storage pubsub instance.

Storage will send StorageEvent messages.

Parameters

storage pointer to a storage API instance.

Returns: pointer to the pubsub instance.

◆ storage_int_backup()

FS_Error storage_int_backup	(	Storage *	storage,
		const char *	dstname )

Back up the internal storage contents to a *.tar archive.

Parameters

storage	pointer to a storage API instance.
dstname	pointer to a zero-terminated string containing the archive file path.

Returns: FSE_OK if the storage was successfully backed up, any other error code on failure.

◆ storage_int_restore()

FS_Error storage_int_restore	(	Storage *	storage,
		const char *	dstname,
		StorageNameConverter	converter )

Restore the internal storage contents from a *.tar archive.

Parameters

storage	pointer to a storage API instance.
dstname	pointer to a zero-terminated string containing the archive file path.
converter	pointer to a filename conversion function (may be NULL).

Returns: FSE_OK if the storage was successfully restored, any other error code on failure.

◆ storage_sd_format()

FS_Error storage_sd_format ( Storage * storage )

Format the SD Card.

Parameters

storage pointer to a storage API instance.

Returns: FSE_OK if the card was successfully formatted, any other error code on failure.

◆ storage_sd_info()

FS_Error storage_sd_info	(	Storage *	storage,
		SDInfo *	info )

Get SD card information.

Parameters

storage	pointer to a storage API instance.
info	pointer to the info object to contain the requested information.

Returns: FSE_OK if the info was successfully received, any other error code on failure.

◆ storage_sd_mount()

FS_Error storage_sd_mount ( Storage * storage )

Mount the SD card.

Parameters

storage pointer to a storage API instance.

Returns: FSE_OK if the card was successfully mounted, any other error code on failure.

◆ storage_sd_status()

FS_Error storage_sd_status ( Storage * storage )

Get SD card status.

Parameters

storage pointer to a storage API instance.

Returns: storage status in the form of a numeric error identifier.

◆ storage_sd_unmount()

FS_Error storage_sd_unmount ( Storage * storage )

Unmount the SD card.

These return values have special meaning:

FSE_NOT_READY if the SD card is not mounted.
FSE_DENIED if there are open files on the SD card.

Parameters

storage pointer to a storage API instance.

Returns: FSE_OK if the card was successfully formatted, any other error code on failure.

◆ storage_simply_mkdir()

bool storage_simply_mkdir	(	Storage *	storage,
		const char *	path )

Create a directory.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the directory path.

Returns: true on success or if directory does already exist, false otherwise.

◆ storage_simply_remove()

bool storage_simply_remove	(	Storage *	storage,
		const char *	path )

Remove a file or a directory.

The following conditions must be met:

the directory must be empty.
the file or the directory must NOT be open.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the item path.

Returns: true on success or if the item does not exist, false otherwise.

◆ storage_simply_remove_recursive()

bool storage_simply_remove_recursive	(	Storage *	storage,
		const char *	path )

Recursively remove a file or a directory.

Unlike storage_simply_remove(), the directory does not need to be empty.

Parameters

storage	pointer to a storage API instance.
path	pointer to a zero-terminated string containing the item path.

Returns: true on success or if the item does not exist, false otherwise.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ANY_PATH

◆ APP_ASSETS_PATH

◆ APP_DATA_PATH

◆ EXT_PATH

◆ INT_PATH

Enumeration Type Documentation

◆ StorageEventType

Function Documentation

◆ storage_common_copy()

◆ storage_common_equivalent_path()

◆ storage_common_exists()

◆ storage_common_fs_info()

◆ storage_common_is_subdir()

◆ storage_common_merge()

◆ storage_common_migrate()

◆ storage_common_mkdir()

◆ storage_common_remove()

◆ storage_common_rename()

◆ storage_common_resolve_path_and_ensure_app_directory()

◆ storage_common_stat()

◆ storage_common_timestamp()

◆ storage_dir_close()

◆ storage_dir_exists()

◆ storage_dir_open()

◆ storage_dir_read()

◆ storage_dir_rewind()

◆ storage_error_get_desc()

◆ storage_file_alloc()

◆ storage_file_close()

◆ storage_file_copy_to_file()

◆ storage_file_eof()

◆ storage_file_exists()

◆ storage_file_free()

◆ storage_file_get_error()

◆ storage_file_get_error_desc()

◆ storage_file_get_internal_error()

◆ storage_file_is_dir()

◆ storage_file_is_open()

◆ storage_file_open()

◆ storage_file_read()

◆ storage_file_seek()

◆ storage_file_size()

◆ storage_file_sync()

◆ storage_file_tell()

◆ storage_file_truncate()

◆ storage_file_write()

◆ storage_get_next_filename()

◆ storage_get_pubsub()

◆ storage_int_backup()

◆ storage_int_restore()

◆ storage_sd_format()

◆ storage_sd_info()

◆ storage_sd_mount()

◆ storage_sd_status()

◆ storage_sd_unmount()

◆ storage_simply_mkdir()

◆ storage_simply_remove()

◆ storage_simply_remove_recursive()