Struct SqliteFs

pub struct SqliteFs { /* private fields */ }

Holds the path of the FS file and the DB Pool

Implementations

impl SqliteFs

pub async fn init(mode: FsMode) -> Result<(), FsStatus>

Init the SQLite Filesystem. Must be called one time before anything can be used!

Args:

• mode - Mode how to create the FS

Return:

• () - Init was successful
• FsStatus::ErrorFsAlreadyInit - FS is already initialized
• FsStatus::ErrorCreateFs - Could not create FS
• FsStatus::ErrorSetupFs - Could not setup FS
• FsStatus::ErrorInsertFsMeta - Could not insert FS metadata into FS

Behavior:

• If mode == FsMode::Memory the FS will be created in memory only. Nothing will be written to disk automatically. If you want to save your memory FS you need to call SqliteFs::save_memory_fs_to_disk.

• If mode == FsMode::Persist(fs_path) and the FS specified by fs_path does not exist then the FS will be created. When the FS already exist it will be loaded.

pub async fn close()

Close the FS

Behavior: Will set the global FS to None and the init lock to false.

pub async fn save_memory_fs_to_disk(fs_path: &str) -> Result<(), FsStatus>

Saves a Memory FS to disk

Args:

• fs_path - Path where the FS should be created.

Return:

• () - Save was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDumpMemFs - Could not get data from in-memory FS
• FsStatus::ErrorCreateFs - Could not create FS on disk
• FsStatus::ErrorSetupFs - Could not setup disk FS
• FsStatus::ErrorInsertFsMeta - Could not insert FS metadata into disk FS
• FsStatus::ErrorSaveMemFsToDisk - Could not write data to Disk

Behavior: Will update the FS Entry in the following way:

• last_meta_read = datetime('now', 'localtime', 'subsec')
• last_data_read = datetime('now', 'localtime', 'subsec')

pub fn get_fs_path(&self) -> String

Returns the path where the FS is located

Return:

• String - Path of the FS

pub async fn delete(f_name: &str) -> Result<(), FsStatus>

Deletes a file directly and permanently from the FS. There is no trash where the files is moved to. When it’s gone, it’s gone!

Args:

• f_name - Name of the file to delete

Return:

• () - deletion was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDelete - There was some other error

pub async fn truncate(f_name: &str) -> Result<(), FsStatus>

Truncates the content of a file

Args:

• f_name - name of the file to truncate

Return:

• () - truncation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorTruncate - There was some other error

Behavior: Will update the FS Entry in the following way:

• size = 0,
• compress = FALSE,
• size_compressed = NULL,
• data = NULL,
• sha = NULL
• sha_compressed = NULL
• last_modify = datetime('now', 'localtime', 'subsec'),

pub async fn get_filename_list() -> Result<Vec<String>, FsStatus>

Returns a list of all filenames

Return:

• Vec<String> - a list of filenames that were deleted
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorGetFileNameList - There was some other error

pub async fn delete_zero_sized_files() -> Result<Vec<String>, FsStatus>

Delete all files with a size of 0 (zero)

Return:

• Vec<String> - a list of filenames that were deleted
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDeleteFile - There was some other error