Loading...
Searching...
No Matches
FS_Common_Api Struct Reference

Data Fields

FS_Error(*const stat )(void *context, const char *path, FileInfo *fileinfo)
 Common api structure.
 
FS_Error(*const remove )(void *context, const char *path)
 Remove file/directory from storage, directory must be empty, file/directory must not be opened, file/directory must not have FSF_READ_ONLY flag.
 
FS_Error(*const mkdir )(void *context, const char *path)
 Create new directory.
 
FS_Error(*const fs_info )(void *context, const char *fs_path, uint64_t *total_space, uint64_t *free_space)
 Get total and free space storage values.
 
bool(*const equivalent_path )(const char *path1, const char *path2)
 Test whether two paths are equivalent (e.g differing case on a case-insensitive fs)
 

Field Documentation

◆ equivalent_path

bool(*const FS_Common_Api::equivalent_path) (const char *path1, const char *path2)

Test whether two paths are equivalent (e.g differing case on a case-insensitive fs)

Parameters
path1first path to be compared
path2second path to be compared
truncateif set to true, compare only up to the path1's length
Returns
true if path1 and path2 are considered equivalent

◆ fs_info

FS_Error(*const FS_Common_Api::fs_info) (void *context, const char *fs_path, uint64_t *total_space, uint64_t *free_space)

Get total and free space storage values.

Parameters
fs_pathpath of fs
total_spacepointer to total space value
free_spacepointer to free space value
Returns
FS_Error error info

◆ mkdir

FS_Error(*const FS_Common_Api::mkdir) (void *context, const char *path)

Create new directory.

Parameters
pathpath to new directory
Returns
FS_Error error info

◆ remove

FS_Error(*const FS_Common_Api::remove) (void *context, const char *path)

Remove file/directory from storage, directory must be empty, file/directory must not be opened, file/directory must not have FSF_READ_ONLY flag.

Parameters
pathpath to file/directory
Returns
FS_Error error info

◆ stat

FS_Error(*const FS_Common_Api::stat) (void *context, const char *path, FileInfo *fileinfo)

Common api structure.

Open directory to get objects from

Parameters
pathpath to file/directory
fileinfopointer to read FileInfo, can be NULL
namepointer to name buffer, can be NULL
name_lengthname buffer length
Returns
FS_Error error info

The documentation for this struct was generated from the following file: