Struct File 

pub struct File {
    pub id: FileId,
    pub name: String,
    pub mime: String,
    pub folder_id: FolderId,
    pub hash: String,
    pub size: i32,
    pub encrypted: bool,
    pub pinned: bool,
    pub file_key: String,
    pub created_at: DateTime<Utc>,
    pub created_by: Option<UserId>,
    pub parent_id: Option<Uuid>,
}

Fields

id: FileId

Unique identifier for the file

name: String

Name of the file

mime: String

Mime type of the file content

folder_id: FolderId

Parent folder ID

hash: String

Hash of the file bytes stored in S3

size: i32

Size of the file in bytes

encrypted: bool

Whether the file was determined to be encrypted when processing

pinned: bool

Whether the file is marked as pinned

file_key: String

S3 key pointing to the file

created_at: DateTime<Utc>

When the file was created

created_by: Option<UserId>

User who created the file

parent_id: Option<Uuid>

Optional parent file ID if the file is a child of some other file (i.e attachment for an email file)

Implementations

impl File

pub async fn all( db: impl DbExecutor<'_>, offset: u64, page_size: u64, ) -> DbResult<Vec<FileWithScope>>

pub async fn all_by_mime( db: impl DbExecutor<'_>, mime: &str, offset: u64, page_size: u64, ) -> DbResult<Vec<FileWithScope>>

pub async fn move_to_folder( self, db: impl DbExecutor<'_>, folder_id: FolderId, ) -> DbResult<File>

pub async fn rename( self, db: impl DbExecutor<'_>, name: String, ) -> DbResult<File>

pub async fn set_pinned( self, db: impl DbExecutor<'_>, pinned: bool, ) -> DbResult<File>

Updates the pinned state of the file

pub async fn set_encrypted( self, db: impl DbExecutor<'_>, encrypted: bool, ) -> DbResult<File>

Updates the encryption state of the file

pub async fn set_mime( self, db: impl DbExecutor<'_>, mime: String, ) -> DbResult<File>

Updates the mime type of a file

pub async fn create( db: impl DbExecutor<'_>, __arg1: CreateFile, ) -> DbResult<File>

pub async fn all_convertable_paged( db: impl DbExecutor<'_>, offset: u64, page_size: u64, convertable_formats: Vec<&str>, ) -> DbResult<Vec<FileWithScope>>

pub async fn find( db: impl DbExecutor<'_>, scope: &DocumentBoxScopeRaw, file_id: FileId, ) -> DbResult<Option<File>>

Finds a specific file using its full path scope -> folder -> file

pub async fn resolve_path( db: impl DbExecutor<'_>, file_id: FileId, ) -> DbResult<Vec<FolderPathSegment>>

Collects the IDs and names of all parent folders of the provided folder

pub async fn find_by_parent( db: impl DbExecutor<'_>, parent_id: FolderId, ) -> DbResult<Vec<File>>

pub async fn delete(&self, db: impl DbExecutor<'_>) -> DbResult<()>

Deletes the file

pub async fn resolve_with_extra( db: impl DbExecutor<'_>, scope: &DocumentBoxScopeRaw, file_ids: Vec<Uuid>, ) -> DbResult<Vec<WithFullPath<FileWithExtra>>>

Finds a collection of files that are all within the same document box, resolves both the files themselves and the folder path to traverse to get to each file

pub async fn resolve_with_extra_mixed_scopes( db: impl DbExecutor<'_>, files_scope_with_id: Vec<(DocumentBoxScopeRaw, FileId)>, ) -> DbResult<Vec<WithFullPathScope<FileWithExtra>>>

Finds a collection of files that are within various document box scopes, resolves both the files themselves and the folder path to traverse to get to each file

pub async fn find_with_extra( db: impl DbExecutor<'_>, scope: &DocumentBoxScopeRaw, file_id: FileId, ) -> DbResult<Option<FileWithExtra>>

Finds a specific file using its full path scope -> folder -> file fetching the additional details about the file like the creator and last modified

pub async fn find_by_parent_folder_with_extra( db: impl DbExecutor<'_>, parent_id: FolderId, ) -> DbResult<Vec<FileWithExtra>>

pub async fn find_by_parent_file_with_extra( db: impl DbExecutor<'_>, parent_id: FileId, ) -> DbResult<Vec<FileWithExtra>>

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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>, FileId: Decode<'a, R::Database> + Type<R::Database>, String: Decode<'a, R::Database> + Type<R::Database>, FolderId: Decode<'a, R::Database> + Type<R::Database>, i32: Decode<'a, R::Database> + Type<R::Database>, bool: Decode<'a, R::Database> + Type<R::Database>, DateTime<Utc>: Decode<'a, R::Database> + Type<R::Database>, Option<UserId>: Decode<'a, R::Database> + Type<R::Database>, Option<Uuid>: Decode<'a, R::Database> + Type<R::Database>,

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

impl Serialize for File

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.