Struct File 

pub struct File {
    pub id: Uuid,
    pub name: String,
    pub mime: String,
    pub folder_id: Uuid,
    pub parent_id: Option<Uuid>,
    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<String>,
}

Fields

id: Uuid

Unique identifier for the file

name: String

Name of the file

mime: String

Mime type of the file content

folder_id: Uuid

Parent folder ID

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)

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<String>

User who created the file

Implementations

impl File

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

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

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

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

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

Updates the pinned state of the file

pub async fn set_encrypted( self, db: impl PgExecutor<'_>, encrypted: bool, ) -> Result<File, Error>

Updates the encryption state of the file

pub async fn set_mime( self, db: impl PgExecutor<'_>, mime: String, ) -> Result<File, Error>

Updates the mime type of a file

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

pub async fn all_by_mimes( db: impl PgExecutor<'_>, mimes: &[&str], offset: u64, page_size: u64, ) -> Result<Vec<FileWithScope>, Error>

pub async fn find( db: impl PgExecutor<'_>, scope: &String, file_id: Uuid, ) -> Result<Option<File>, Error>

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

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

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

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

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

Deletes the file

pub async fn resolve_with_extra( db: impl PgExecutor<'_>, scope: &String, file_ids: Vec<Uuid>, ) -> Result<Vec<WithFullPath<FileWithExtra>>, Error>

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 PgExecutor<'_>, files_scope_with_id: Vec<DocboxInputPair<'_>>, ) -> Result<Vec<WithFullPathScope<FileWithExtra>>, Error>

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

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

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

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

Get the total number of files in the tenant

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

Get the total “size” of files within the current tenant, this does not include the size of generated files

pub async fn total_size_within_scope( db: impl PgExecutor<'_>, scope: &str, ) -> Result<i64, Error>

Get the total “size” of files within a specific scope, this does not include the size of generated files

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

Formats the value using the given formatter.

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

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

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

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

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

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 + Send + Sync>>

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, R> FromRow<'a, R> for File

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>, Option<Uuid>: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, i32: Decode<'a, <R as Row>::Database> + Type<<R as Row>::Database>, bool: 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<File, Error>

impl PartialEq for File

fn eq(&self, other: &File) -> 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 File

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Serialize for File

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 File

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 File

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 File