Struct Folder 

pub struct Folder {
    pub id: FolderId,
    pub name: String,
    pub pinned: bool,
    pub document_box: DocumentBoxScopeRaw,
    pub folder_id: Option<FolderId>,
    pub created_at: DateTime<Utc>,
    pub created_by: Option<UserId>,
}

Fields

id: FolderId

Unique identifier for the folder

name: String

Name of the file

pinned: bool

Whether the folder is marked as pinned

document_box: DocumentBoxScopeRaw

ID of the document box the folder belongs to

folder_id: Option<FolderId>

Parent folder ID if the folder is a child

created_at: DateTime<Utc>

When the file was created

created_by: Option<UserId>

User who created the folder

Implementations

impl Folder

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

Collects the IDs of all child folders within the current folder

Results are passed to the search engine when searching within a specific folder to only get results from the folder subtree

pub async fn count_children( db: impl DbExecutor<'_>, folder_id: FolderId, ) -> DbResult<FolderChildrenCount>

Uses a recursive query to count all the children in the provided folder

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

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

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

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

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

pub async fn find_by_id( db: impl DbExecutor<'_>, scope: &DocumentBoxScopeRaw, id: FolderId, ) -> DbResult<Option<Folder>>

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

Get all folders and sub folder across any scope in a paginated fashion (Ignores roots of document boxes)

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

pub async fn find_root( db: impl DbExecutor<'_>, document_box: &DocumentBoxScopeRaw, ) -> DbResult<Option<Folder>>

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

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

Deletes the folder

pub async fn resolve_with_extra_mixed_scopes( db: impl DbExecutor<'_>, folders_scope_with_id: Vec<(DocumentBoxScopeRaw, FolderId)>, ) -> DbResult<Vec<WithFullPathScope<FolderWithExtra>>>

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

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

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

pub async fn find_by_id_with_extra( db: impl DbExecutor<'_>, scope: &DocumentBoxScopeRaw, id: FolderId, ) -> DbResult<Option<FolderWithExtra>>

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

pub async fn find_root_with_extra( db: impl DbExecutor<'_>, document_box: &DocumentBoxScopeRaw, ) -> DbResult<Option<FolderWithExtra>>

pub async fn total_count(db: impl DbExecutor<'_>) -> DbResult<i64>

Get the total number of folders in the tenant

Trait Implementations

impl Clone for Folder

fn clone(&self) -> Folder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Folder

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

Formats the value using the given formatter.

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

where &'a str: ColumnIndex<R>, FolderId: Decode<'a, R::Database> + Type<R::Database>, String: Decode<'a, R::Database> + Type<R::Database>, bool: Decode<'a, R::Database> + Type<R::Database>, DocumentBoxScopeRaw: Decode<'a, R::Database> + Type<R::Database>, Option<FolderId>: 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>,

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

impl Serialize for Folder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.