Struct Folder 

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

Fields

id: Uuid

Unique identifier for the folder

name: String

Name of the file

pinned: bool

Whether the folder is marked as pinned

document_box: String

ID of the document box the folder belongs to

folder_id: Option<Uuid>

Parent folder ID if the folder is a child

created_at: DateTime<Utc>

When the folder was created

created_by: Option<String>

User who created the folder

Implementations

impl Folder

pub async fn create( db: impl PgExecutor<'_>, __arg1: CreateFolder, ) -> Result<Folder, Error>

pub async fn tree_all_children( &self, db: impl PgExecutor<'_>, ) -> Result<Vec<Uuid>, Error>

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 PgExecutor<'_>, folder_id: Uuid, ) -> Result<FolderChildrenCount, Error>

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

pub async fn resolve_path( db: impl PgExecutor<'_>, folder_id: Uuid, ) -> Result<Vec<FolderPathSegment>, Error>

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

pub async fn move_to_folder( self, db: impl PgExecutor<'_>, folder_id: Uuid, ) -> Result<Folder, Error>

pub async fn rename( self, db: impl PgExecutor<'_>, name: String, ) -> Result<Folder, Error>

pub async fn set_pinned( self, db: impl PgExecutor<'_>, pinned: bool, ) -> Result<Folder, Error>

pub async fn find_by_id( db: impl PgExecutor<'_>, scope: &String, id: Uuid, ) -> Result<Option<Folder>, Error>

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

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 PgExecutor<'_>, parent_id: Uuid, ) -> Result<Vec<Folder>, Error>

pub async fn find_root( db: impl PgExecutor<'_>, document_box: &String, ) -> Result<Option<Folder>, Error>

pub async fn delete( &self, db: impl PgExecutor<'_>, ) -> Result<PgQueryResult, Error>

Deletes the folder

pub async fn resolve_with_extra_mixed_scopes( db: impl PgExecutor<'_>, folders_scope_with_id: Vec<DocboxInputPair<'_>>, ) -> Result<Vec<WithFullPath<FolderWithExtra>>, Error>

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 PgExecutor<'_>, scope: &String, folder_ids: Vec<Uuid>, ) -> Result<Vec<WithFullPath<FolderWithExtra>>, Error>

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 PgExecutor<'_>, scope: &String, id: Uuid, ) -> Result<Option<WithFullPath<FolderWithExtra>>, Error>

pub async fn find_by_parent_with_extra( db: impl PgExecutor<'_>, parent_id: Uuid, ) -> Result<Vec<FolderWithExtra>, Error>

pub async fn find_root_with_extra( db: impl PgExecutor<'_>, document_box: &String, ) -> Result<Option<WithFullPath<FolderWithExtra>>, Error>

pub async fn total_count(db: impl PgExecutor<'_>) -> Result<i64, Error>

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<(), Error>

Formats the value using the given formatter.

impl<'r> Decode<'r, Postgres> for Folder

fn decode(value: PgValueRef<'r>) -> Result<Folder, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<'q> Encode<'_, Postgres> for Folder

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf without moving self.

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

impl<'a> From<&'a Folder> for FolderPathSegment

fn from(value: &'a Folder) -> FolderPathSegment

Converts to this type from the input type.

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

where R: Row, &'a str: ColumnIndex<R>, Uuid: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, String: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, bool: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, Option<Uuid>: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, DateTime<Utc>: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, Option<String>: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>,

fn from_row(__row: &'a R) -> Result<Folder, Error>

impl PartialEq for Folder

fn eq(&self, other: &Folder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PgHasArrayType for Folder

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Serialize for Folder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Folder

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Type<Postgres> for Folder

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Eq for Folder