Struct ApiV3Client 

pub struct ApiV3Client {
    pub base_url: String,
    pub http_client: Client,
    pub session_cookie: Option<String>,
}

API v3 client structure

Fields

base_url: String

http_client: Client

session_cookie: Option<String>

Implementations

impl ApiV3Client

pub async fn create_download( &self, request: &Aria2CreateRequest<'_>, ) -> Result<(), Error>

Create offline download

pub async fn list_downloading(&self) -> Result<Vec<Aria2Task>, Error>

List downloading tasks

pub async fn list_finished(&self) -> Result<Vec<Aria2Task>, Error>

List finished tasks

pub async fn delete_task(&self, gid: &str) -> Result<(), Error>

Delete task

impl ApiV3Client

pub async fn list_directory(&self, path: &str) -> Result<DirectoryList, Error>

List directory contents

pub async fn create_directory( &self, request: &CreateDirectoryRequest<'_>, ) -> Result<(), Error>

Create a directory

impl ApiV3Client

pub async fn upload_file( &self, request: &UploadFileRequest<'_>, ) -> Result<UploadSession, Error>

pub async fn complete_upload(&self, session_id: &str) -> Result<(), Error>

pub async fn upload_chunk( &self, session_id: &str, _chunk_index: u32, data: Vec<u8>, ) -> Result<(), Error>

pub async fn download_file(&self, id: &str) -> Result<DownloadUrl, Error>

pub async fn get_file_source( &self, request: &FileSourceRequest, ) -> Result<Vec<FileSource>, Error>

pub async fn preview_file(&self, id: &str) -> Result<DirectoryList, Error>

pub async fn get_thumbnail(&self, id: &str) -> Result<DirectoryList, Error>

pub async fn create_file( &self, request: &CreateFileRequest<'_>, ) -> Result<(), Error>

impl ApiV3Client

pub async fn get_object_property( &self, id: &str, is_folder: Option<bool>, trace_root: Option<bool>, ) -> Result<Property, Error>

Get object (file/folder) property

pub async fn rename_object( &self, request: &RenameObjectRequest<'_>, ) -> Result<(), Error>

Rename object

pub async fn move_object( &self, request: &MoveObjectRequest<'_>, ) -> Result<(), Error>

Move object

pub async fn copy_object( &self, request: &CopyObjectRequest<'_>, ) -> Result<(), Error>

Copy object

pub async fn delete_object( &self, request: &DeleteObjectRequest<'_>, ) -> Result<(), Error>

Delete object

impl ApiV3Client

pub async fn login(&mut self, request: &LoginRequest<'_>) -> Result<User, Error>

Login with email and password

pub async fn login_2fa( &mut self, request: &OtpLoginRequest, ) -> Result<User, Error>

Login with OTP (Two-Factor Authentication)

pub async fn logout(&self) -> Result<(), Error>

Logout from current session

impl ApiV3Client

pub async fn create_share(&self, request: &ShareRequest) -> Result<Share, Error>

Create a share link Note: The V3 API may return either an ApiResponse object or a plain string URL

impl ApiV3Client

pub async fn get_site_config(&self) -> Result<SiteConfig, Error>

Get site configuration

pub async fn get_user_storage(&self) -> Result<StorageInfo, Error>

Get user storage information

pub async fn ping(&self) -> Result<String, Error>

Ping the server and get server version

pub async fn get_version(&self) -> Result<VersionInfo, Error>

Get API version information

pub async fn get_user_settings(&self) -> Result<StorageInfo, Error>

Get user settings

pub async fn get_task_queue(&self) -> Result<Vec<Aria2Task>, Error>

Get task queue

impl ApiV3Client

pub async fn get_webdav_accounts(&self) -> Result<Vec<WebdavAccount>, Error>

Get WebDAV accounts

impl ApiV3Client

pub fn new(base_url: &str) -> Self

pub fn set_session_cookie(&mut self, cookie: String)

pub fn get_session_cookie(&self) -> Option<&str>

pub fn clear_session_cookie(&mut self)

pub fn get_url(&self, endpoint: &str) -> String

pub async fn get<T>(&self, endpoint: &str) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn post<T>( &self, endpoint: &str, body: &impl Serialize, ) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn post_raw( &self, endpoint: &str, body: &impl Serialize, ) -> Result<String, Error>

POST request that returns raw text instead of parsing JSON

pub async fn put<T>( &self, endpoint: &str, body: &impl Serialize, ) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn patch<T>( &self, endpoint: &str, body: &impl Serialize, ) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn delete<T>(&self, endpoint: &str) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn delete_with_body<T>( &self, endpoint: &str, body: &impl Serialize, ) -> Result<T, Error>

where T: DeserializeOwned + Debug,

pub async fn put_text( &self, endpoint: &str, body: &impl Serialize, ) -> Result<String, Error>

PUT request that returns raw text response instead of JSON

Trait Implementations

impl Clone for ApiV3Client

fn clone(&self) -> ApiV3Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiV3Client

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

Formats the value using the given formatter.