Struct mongo_file_center::FileCenter

pub struct FileCenter { /* fields omitted */ }

To store perennial files and temporary files in MongoDB.

Implementations

impl FileCenter

pub async fn new<U: AsRef<str>>(uri: U) -> Result<FileCenter, FileCenterError>

Create a new FileCenter instance.

pub async fn new_with_file_size_threshold<U: AsRef<str>>(
    uri: U,
    initial_file_size_threshold: u32
) -> Result<FileCenter, FileCenterError>

Create a new FileCenter instance with a custom initial file size threshold.

impl FileCenter

pub const fn get_file_size_threshold(&self) -> u32

Change the file size threshold.

pub async fn set_file_size_threshold(
    &mut self,
    file_size_threshold: u32
) -> Result<(), FileCenterError>

Change the file size threshold.

pub async fn drop_database(self) -> Result<(), FileCenterError>

Drop the database.

pub async fn drop_file_center(self) -> Result<(), FileCenterError>

Drop the file center. But remain the database.

impl FileCenter

pub async fn check_file_item_exist(
    &self,
    id: ObjectId
) -> Result<bool, FileCenterError>

Check whether the file exists or not. If the file is temporary, it will still remain in the database.

pub async fn get_file_item_by_id(
    &self,
    id: ObjectId
) -> Result<Option<FileItem<impl Stream<Item = Result<Cursor<Vec<u8>>, Error>> + Unpin>>, FileCenterError>

Get the file item via an Object ID.

pub async fn delete_file_item_by_id(
    &self,
    file_id: ObjectId
) -> Result<Option<u64>, FileCenterError>

Remove a file item via an Object ID.

impl FileCenter

pub async fn put_file_by_path<P: AsRef<Path>, S: Into<String>>(
    &self,
    file_path: P,
    file_name: Option<S>,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Input a file to the file center via a file path.

pub async fn put_file_by_path_temporarily<P: AsRef<Path>, S: Into<String>>(
    &self,
    file_path: P,
    file_name: Option<S>,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Temporarily input a file to the file center via a file path.

impl FileCenter

pub async fn put_file_by_buffer<B: AsRef<[u8]> + Into<Vec<u8>>, S: Into<String>>(
    &self,
    buffer: B,
    file_name: S,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Input a file to the file center via a buffer.

pub async fn put_file_by_buffer_temporarily<B: AsRef<[u8]> + Into<Vec<u8>>, S: Into<String>>(
    &self,
    buffer: B,
    file_name: S,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Temporarily input a file to the file center via a buffer.

impl FileCenter

pub async fn put_file_by_reader<R: AsyncRead + Unpin, S: Into<String>>(
    &self,
    reader: R,
    file_name: S,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Input a file to the file center via a reader.

pub async fn put_file_by_reader_temporarily<R: AsyncRead + Unpin, S: Into<String>>(
    &self,
    reader: R,
    file_name: S,
    mime_type: Option<Mime>
) -> Result<ObjectId, FileCenterError>

Temporarily input a file to the file center via a reader.

impl FileCenter

pub async fn clear_garbage(&self) -> Result<(), FileCenterError>

Remove all unused file meta and file chunks in this file center.

impl FileCenter

pub unsafe fn database(&self) -> &Database

Get the reference of MongoDB Database.

impl FileCenter

pub fn decrypt_id_token<S: AsRef<str>>(
    &self,
    id_token: S
) -> Result<ObjectId, FileCenterError>

Decrypt a ID token to an Object ID.

pub fn encrypt_id(&self, id: ObjectId) -> IDToken

Encrypt an Object ID to an ID token.

pub fn encrypt_id_to_buffer(&self, id: ObjectId, buffer: String) -> String

Encrypt an Object ID to an ID token.

Trait Implementations

impl Debug for FileCenter

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

Formats the value using the given formatter.