Struct tosho_rbean::RBClient

pub struct RBClient { /* private fields */ }

Main client for interacting with the 小豆 (Red Bean) API

Examples

use tosho_rbean::{RBClient, RBConfig, RBPlatform};

#[tokio::main]
async fn main() {
    let config = RBConfig {
        token: "123".to_string(),
        refresh_token: "abcxyz".to_string(),
        platform: RBPlatform::Android,
    };

    let mut client = RBClient::new(config);
    // Refresh token
    client.refresh_token().await.unwrap();
    let user = client.get_user().await.unwrap();
    println!("{:?}", user);
}

Implementations

impl RBClient

pub fn new(config: RBConfig) -> Self

Create a new client instance.

Arguments

• config - The configuration to use for the client.

pub fn with_proxy(&self, proxy: Proxy) -> Self

Attach a proxy to the client.

This will clone the client and return a new client with the proxy attached.

Arguments

• proxy - The proxy to attach to the client

pub fn set_expiry_at(&mut self, expiry_at: Option<i64>)

pub async fn refresh_token(&mut self) -> Result<()>

Refresh the token of the client.

The following function will be called on each request to ensure the token is always valid.

The first request will always be a token refresh, and subsequent requests will only refresh if the token is expired.

pub fn get_token(&self) -> &str

Get the current token of the client.

pub fn get_expiry_at(&self) -> Option<i64>

Get the expiry time of the token.

pub async fn get_user(&mut self) -> Result<UserAccount>

Get the current user account information.

pub async fn get_reading_list(&mut self) -> Result<Vec<ReadingListItem>>

Get the current user reading list.

pub async fn get_manga(&mut self, uuid: &str) -> Result<Manga>

Get the manga information for a specific manga.

Arguments

• uuid - The UUID of the manga.

pub async fn get_manga_filters(&mut self) -> Result<Manga>

Get the manga filters for searching manga.

pub async fn get_chapter_list( &mut self, uuid: &str, ) -> Result<ChapterListResponse>

Get chapter list for a specific manga.

Arguments

• uuid - The UUID of the manga.

pub async fn get_chapter( &mut self, uuid: &str, ) -> Result<ChapterDetailsResponse>

Get the chapter details for a specific chapter.

Arguments

• uuid - The UUID of the chapter.

pub async fn get_chapter_viewer( &mut self, uuid: &str, ) -> Result<ChapterPageDetailsResponse>

Get the chapter viewer for a specific chapter.

Arguments

• uuid - The UUID of the chapter.

pub async fn search( &mut self, query: &str, offset: Option<u32>, count: Option<u32>, sort: Option<SortOption>, ) -> Result<MangaListResponse>

Do a search for a manga.

Arguments

• query - The query to search for.
• offset - The offset of the search result, default to 0
• count - The count of the search result, default to 999
• sort - The sort option of the search result, default to SortOption::Alphabetical

pub async fn get_home_page(&mut self) -> Result<HomeResponse>

Get the home page information.

pub async fn get_publisher(&mut self, slug: &str) -> Result<Publisher>

Get specific publisher information by their slug.

Arguments

• slug - The slug of the publisher.

pub fn modify_url_for_highres(url: &str) -> Result<String>

Modify the URL to get the high resolution image URL.

Arguments

• url - The URL to modify.

pub async fn stream_download( &self, url: &str, writer: impl AsyncWrite + Unpin, ) -> Result<()>

Stream download the image from the given URL.

The URL can be obtained from RBClient::get_chapter_viewer.

Parameters

• url - The URL to download the image from.
• writer - The writer to write the image to.

pub async fn test_high_res(&self, url: &str) -> Result<bool>

Try checking if the “hidden” high resolution image is available.

Give the URL of any image that is requested from the API.

pub async fn login( email: &str, password: &str, platform: RBPlatform, ) -> Result<RBLoginResponse>

Trait Implementations

impl Clone for RBClient

fn clone(&self) -> RBClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RBClient

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

Formats the value using the given formatter.