Skip to main content

ExplorerApi

cloudreve_sdk_api::api::explorer

Trait ExplorerApi 

Source 
pub trait ExplorerApi {

Show 23 methods    // Required methods
    fn list_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        params: &'life1 ListFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<ListResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_file_thumb<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        path: &'life1 str,
        context_hint: Option<&'life2 str>,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileThumbResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn get_file_info<'life0, 'life1, 'async_trait>(
        &'life0 self,
        params: &'life1 GetFileInfoService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn create_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 CreateFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn delete_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 DeleteFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn rename_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 RenameFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn move_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 MoveFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn restore_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 DeleteFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn patch_metadata<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 PatchMetadataService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_file_url<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 FileURLService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileURLResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn unlock_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 UnlockFileService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn set_current_version<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 VersionControlService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn delete_version<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 VersionControlService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn update_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        params: &'life1 FileUpdateService,
        data: Bytes,
    ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn get_storage_policy_options<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = ApiResult<Vec<StoragePolicy>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn mount_storage_policy<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 MountPolicyService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<Vec<StoragePolicy>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn set_permissions<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 SetPermissionService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn create_upload_session<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 UploadSessionRequest,
    ) -> Pin<Box<dyn Future<Output = ApiResult<UploadCredential>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn upload_chunk<'life0, 'life1, 'async_trait>(
        &'life0 self,
        session_id: &'life1 str,
        chunk_index: usize,
        data: Bytes,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn upload_chunk_stream<'life0, 'life1, 'async_trait>(
        &'life0 self,
        session_id: &'life1 str,
        chunk_index: usize,
        content_length: u64,
        body: Body,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn delete_upload_session<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: &'life1 DeleteUploadSessionService,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn complete_s3_upload<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        policy_type: &'life1 str,
        session_id: &'life2 str,
        session_key: &'life3 str,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait;
    fn complete_onedrive_upload<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        session_id: &'life1 str,
        session_key: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;

}
Expand description

File explorer API methods

Required Methods§

Source

fn list_files<'life0, 'life1, 'async_trait>( &'life0 self, params: &'life1 ListFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<ListResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List files in a directory

Source

fn get_file_thumb<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 str, context_hint: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = ApiResult<FileThumbResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Get file thumbnail

Source

fn get_file_info<'life0, 'life1, 'async_trait>( &'life0 self, params: &'life1 GetFileInfoService, ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get file information

Source

fn create_file<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 CreateFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a new file or folder

Source

fn delete_files<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 DeleteFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete files

Source

fn rename_file<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 RenameFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Rename a file

Source

fn move_files<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MoveFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Move files

Source

fn restore_files<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 DeleteFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restore files from trash

Source

fn patch_metadata<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 PatchMetadataService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Patch file metadata

Source

fn get_file_url<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 FileURLService, ) -> Pin<Box<dyn Future<Output = ApiResult<FileURLResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get file entity URL

Source

fn unlock_files<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 UnlockFileService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Unlock files

Source

fn set_current_version<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 VersionControlService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set current version

Source

fn delete_version<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 VersionControlService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete version

Source

fn update_file<'life0, 'life1, 'async_trait>( &'life0 self, params: &'life1 FileUpdateService, data: Bytes, ) -> Pin<Box<dyn Future<Output = ApiResult<FileResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update file content

Source

fn get_storage_policy_options<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ApiResult<Vec<StoragePolicy>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get storage policy options

Source

fn mount_storage_policy<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 MountPolicyService, ) -> Pin<Box<dyn Future<Output = ApiResult<Vec<StoragePolicy>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Mount storage policy

Source

fn set_permissions<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 SetPermissionService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set file permissions

Source

fn create_upload_session<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 UploadSessionRequest, ) -> Pin<Box<dyn Future<Output = ApiResult<UploadCredential>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create upload session

Source

fn upload_chunk<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, chunk_index: usize, data: Bytes, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Upload chunk

Source

fn upload_chunk_stream<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, chunk_index: usize, content_length: u64, body: Body, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Upload chunk using streaming body (for large chunks)

Source

fn delete_upload_session<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 DeleteUploadSessionService, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete upload session

Source

fn complete_s3_upload<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, policy_type: &'life1 str, session_id: &'life2 str, session_key: &'life3 str, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Complete S3-like upload

Source

fn complete_onedrive_upload<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, session_key: &'life2 str, ) -> Pin<Box<dyn Future<Output = ApiResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Complete OneDrive upload

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§