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 copy(from: &str, to: &str) -> Result<(), FsStatus>

Copies the contents of one file to another.

This function will overwrite the contents of to.

Args:

• from - actual file name
• to - new file name

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn exists(path: &str) -> Result<bool, FsStatus>

Given a path, queries the file system to get information about a file

Args:

• path - Name of the File

Return:

• Ok(true) - file exist
• Ok(true) - file does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn metadata(path: &str) -> Result<SqliteFsFileMeta, FsStatus>

Given a path, queries the file system to get information about a file

Args:

• path - Name of the File

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn read(path: &str) -> Result<Vec<u8>, FsStatus>

Reads the entire contents of a file into a bytes vector.

Args:

• path - Name of the File

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorInvalidCompressionLevel - compression level is invalid
• FsStatus::ErrorDb - DB Transaction Error

pub async fn read_all(path: &str) -> Result<Vec<String>, FsStatus>

Read all FS entry names where name starts with path. (std::fs::read_dir)

Args:

• path - Name of the dir

Return:

• Ok(Vec<String>) - list with the entry names within a directory
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDirNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn read_to_string(path: &str) -> Result<String, FsStatus>

Reads the entire contents of a file into a string.

Args:

• path - Name of the File

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorInvalidCompressionLevel - compression level is invalid
• FsStatus::ErrorDb - DB Transaction Error
• FsStatus::ErrorReadToString - Could not convert file data to string

pub async fn remove_all(path: &str) -> Result<Vec<String>, FsStatus>

Removes all FS entries where name starts with path. Think of it like rm -rf /my/path/my_fi* (std::fs::remove_dir)

Args:

• path - Name of the dir

Return:

• Ok(Vec<String>) - list with names of deleted files
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDirNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn remove_file(path: &str) -> Result<(), FsStatus>

Removes a file from the filesystem.

Args:

• path - Name of the File

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn rename(from: &str, to: &str) -> Result<(), FsStatus>

Writes a slice as the entire contents of a file.

This function will create a file if it does not exist, and will entirely replace its contents if it does.

Args:

• from - actual file name
• to - new file name

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorFileNotFound - File from does not exist
• FsStatus::ErrorDb - DB Transaction Error

pub async fn write(path: &str, data: &[u8]) -> Result<(), FsStatus>

Writes a slice as the entire contents of a file.

This function will create a file if it does not exist, and will entirely replace its contents if it does.

Args:

• path - Name of the File
• data - data to write to file

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorDb - DB Transaction Error

pub async fn write_compressed( path: &str, data: &[u8], compression_level: i64, ) -> Result<(), FsStatus>

Writes a slice as the entire contents of a file.

This function will create a file if it does not exist, and will entirely replace its contents if it does.

Args:

• path - Name of the File
• data - data to compress to write to file
• compression_level - Range: >= 1 && <= 9 (1: lowest compression level -> 9: highest compression level)

Return:

• Ok(()) - Operation was successful
• FsStatus::ErrorFsNotInit - FS is not initialized
• FsStatus::ErrorInvalidCompressionLevel - Compression level is out of range
• FsStatus::ErrorDb - DB Transaction Error