gazelle_api 0.16.0

Gazelle API Client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use async_trait::async_trait;

use crate::{
    BrowseRequest, BrowseResponse, GazelleError, GroupResponse, TorrentResponse, UploadForm,
    UploadResponse, User,
};

/// Trait for Gazelle API operations
///
/// Implemented by [`GazelleClient`] for production use and
/// [`MockGazelleClient`] (with `mock` feature) for testing.
#[async_trait]
pub trait GazelleClientTrait: Send + Sync {
    /// Execute a browse query
    async fn browse(&self, request: &BrowseRequest) -> Result<BrowseResponse, GazelleError>;

    /// Get a torrent by id
    async fn get_torrent(&self, id: u32) -> Result<TorrentResponse, GazelleError>;

    /// Get a torrent group by id
    async fn get_torrent_group(&self, id: u32) -> Result<GroupResponse, GazelleError>;

    /// Get a user by id
    async fn get_user(&self, id: u32) -> Result<User, GazelleError>;

    /// Download torrent file content
    async fn download_torrent(&self, id: u32) -> Result<Vec<u8>, GazelleError>;

    /// Upload a torrent
    async fn upload_torrent(&self, upload: UploadForm) -> Result<UploadResponse, GazelleError>;
}