Struct File

pub struct File { /* private fields */ }

Text

Implementations

impl File

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

Creates a new file inside the FS

Args:

• f_name - Name of the File

Return:

• Ok(Self) - File was creates successful
• Err(FsStatus::ErrorFsNotInit) - FS is not initialized
• Err(FsStatus::ErrorFileExist(msg)) - Could not create file because a file with this name already exist
• Err(FsStatus::ErrorCreateFile(msg)) - Could not create file because there was some other error
• Err(FsStatus::ErrorUnknown(msg)) - Could not create file because there was some unknown error

pub async fn rename(&mut self, new_f_name: &str) -> Result<(), FsStatus>

Rename the current file

Args:

• new_f_name - new Name of the File

Return:

• Ok(Self) - File was creates successful
• Err(FsStatus::ErrorFsNotInit) - FS is not initialized
• Err(FsStatus::ErrorTransaction(msg)) - DB Transaction Error
• Err(FsStatus::ErrorFileExist(msg)) - Could not create file because a file with the new name already exist
• Err(FsStatus::ErrorCreateFile(msg)) - Could not create file because there was some other error
• Err(FsStatus::ErrorUnknown(msg)) - Could not create file because there was some unknown error

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

Behavior:

Args:

• `` -

Return:

• `` -

pub async fn delete(self) -> Result<(), FsStatus>

Behavior:

Args:

• `` -

Return:

• `` -

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

Behavior:

Args:

• `` -

Return:

• `` -

pub async fn truncate(&mut self) -> Result<(), FsStatus>

Truncates the content of the current file

Return:

• Ok(()) - truncation was successful
• Err(FsStatus::ErrorFsNotInit) - FS is not initialized
• Err(FsStatus::ErrorTruncate(msg)) - 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 read_to_string(&self, dest: &mut String) -> Result<(), FsStatus>

Behavior:

Args:

• `` -

Return:

• `` -

pub async fn read_to_vec(&self, dest: &mut Vec<u8>) -> Result<(), FsStatus>

Behavior:

Args:

• `` -

Return:

• `` -

pub fn name(&self) -> &str

Return the name of the file

Return:

• String - name of the current file

pub fn size(&self) -> i64

Size of the uncompressed filecontent in bytes

Return:

• i64 - size in bytes

pub fn sha(&self) -> Option<String>

Returns the BASE64 encoded SHA512 of the filecontent

Return:

• Option<String> - BASE64 encoded SHA512

pub fn sha_compressed(&self) -> Option<String>

Returns the BASE64 encoded SHA512 of the compressed filecontent

Return:

• Option<String> - BASE64 encoded SHA512

Trait Implementations

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, R: Row> FromRow<'a, R> for File

where &'a str: ColumnIndex<R>, i64: Decode<'a, R::Database> + Type<R::Database>, String: Decode<'a, R::Database> + Type<R::Database>, Option<String>: Decode<'a, R::Database> + Type<R::Database>, u32: Decode<'a, R::Database> + Type<R::Database>, Option<i64>: Decode<'a, R::Database> + Type<R::Database>,

fn from_row(__row: &'a R) -> Result<Self>