Struct MangaDexClient

pub struct MangaDexClient {
    pub http_client: HttpClientRef,
}

API client to make requests to the MangaDex v5 API.

Fields

http_client: HttpClientRef

Implementations

impl MangaDexClient

pub fn new(client: Client) -> Self

Create a new MangaDexClient with a custom reqwest::Client.

Examples

use reqwest::Client;

use mangadex_api::v5::MangaDexClient;

let reqwest_client = Client::builder()
    .timeout(std::time::Duration::from_secs(10))
    .build()?;

let client = MangaDexClient::new(reqwest_client);

pub fn new_with_http_client_ref(http_client: HttpClientRef) -> Self

Create a new MangaDexClient with a custom client reference

pub fn new_with_http_client(http_client: HttpClient) -> Self

Create a new MangaDexClient with a custom HttpClient.

In most cases, providing a custom HttpClient isn’t necessary. This function is primarily useful for mock testing but is available for anyone that needs to change the base URL if it changes due to an unforeseen event.

Examples

use reqwest::Client;
use url::Url;

use mangadex_api::v5::MangaDexClient;
use mangadex_api::HttpClient;

let reqwest_client = Client::builder()
    .timeout(std::time::Duration::from_secs(10))
    .build()?;

let http_client = HttpClient::builder()
    .client(reqwest_client)
    .base_url(Url::parse("127.0.0.1:8080")?)
    .build()?;

let client = MangaDexClient::new_with_http_client(http_client);

pub fn get_http_client(&self) -> HttpClientRef

Return the Reqwest Client.

This can be used to create manual HTTP requests.

Using this is generally not advised as it can provide mutable access to the HttpClient.

pub async fn set_auth_tokens(&mut self, auth_tokens: &AuthTokens) -> Result<()>

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

pub async fn get_auth_tokens(&self) -> Result<AuthTokens>

pub async fn set_captcha<A: Into<String>>(&mut self, captcha: A) -> Result<()>

pub async fn get_captcha(&self) -> Result<String>

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

pub async fn get_client_info(&self) -> Result<ClientInfo>

Available on crate feature oauth only.

pub fn at_home(&self) -> AtHomeBuilder

Get a builder for handling the At-Home endpoints.

https://api.mangadex.org/swagger.html#/AtHome

pub fn auth(&self) -> AuthBuilder

Get a builder for handling the authentication endpoints.

This builder is deprecated

https://api.mangadex.org/docs/redoc.html#tag/Authentication

pub fn author(&self) -> AuthorBuilder

Get a builder for handling the author endpoints.

https://api.mangadex.org/swagger.html#/Author

pub fn captcha(&self) -> CaptchaBuilder

Get a builder for handling the captcha endpoints.

https://api.mangadex.org/swagger.html#/Captcha

pub fn chapter(&self) -> ChapterBuilder

Get a builder for handling the chapter endpoints.

https://api.mangadex.org/swagger.html#/Chapter

pub fn client(&self) -> ApiClientEndpoint

pub fn cover(&self) -> CoverBuilder

Get a builder for handling manga volume cover art endpoints.

https://api.mangadex.org/swagger.html#/Cover

pub fn custom_list(&self) -> CustomListBuilder

Get a builder for handling the custom list endpoints.

https://api.mangadex.org/swagger.html#/CustomList

pub fn feed(&self) -> FeedBuilder

Get a builder for handling the feed endpoints.

https://api.mangadex.org/swagger.html#/Feed

pub fn ping(&self) -> PingEndpointBuilder

Get a builder for handling the infrastructure endpoints.

https://api.mangadex.org/swagger.html#/Infrastructure

pub fn legacy(&self) -> LegacyBuilder

Get a builder for handling the legacy endpoints.

https://api.mangadex.org/swagger.html#/Legacy

pub fn manga(&self) -> MangaBuilder

Get a builder for handling the manga endpoints.

https://api.mangadex.org/swagger.html#/Manga

pub fn rating(&self) -> RatingBuilder

Get a builder for handling the rating endpoints.

https://api.mangadex.org/swagger.html#/Rating

pub fn report(&self) -> ReportBuilder

Get a builder for handling the report endpoints.

https://api.mangadex.org/swagger.html#/Report

pub fn scanlation_group(&self) -> ScanlationGroupBuilder

Get a builder for handling the scanlation group endpoints.

https://api.mangadex.org/swagger.html#/ScanlationGroup

pub fn search(&self) -> SearchBuilder

Get a builder for handling the search endpoints.

This is a convenience builder that aggregates search endpoints from various categories.

pub fn settings(&self) -> SettingsBuilder

Get a builder for handling the settings endpoints.

https://api.mangadex.org/swagger.html#/Settings

pub fn statistics(&self) -> StatisticsBuilder

Get a builder for handling the statistics endpoints.

https://api.mangadex.org/swagger.html#/Statistics

pub fn upload(&self) -> UploadBuilder

Get a builder for handling uploads.

https://api.mangadex.org/swagger.html#/Upload

pub fn user(&self) -> UserBuilder

Get a builder for handling the user endpoints.

https://api.mangadex.org/swagger.html#/User

pub fn api_dev_client() -> Self

This is an api client for api.mangadex.dev

pub fn forums(&self) -> ForumsEndpoint

pub fn oauth(&self) -> OAuthBuider

Available on crate feature oauth only.

impl MangaDexClient

pub async fn set_client_info(&mut self, client_info: &ClientInfo) -> Result<()>

Available on non-crate feature multi-thread and non-crate feature tokio-multi-thread and non-crate feature rw-multi-thread and crate feature oauth only.

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

Available on non-crate feature multi-thread and non-crate feature tokio-multi-thread and non-crate feature rw-multi-thread and crate feature oauth only.

Trait Implementations

impl Clone for MangaDexClient

fn clone(&self) -> MangaDexClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MangaDexClient

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

Formats the value using the given formatter.

impl Default for MangaDexClient

fn default() -> Self

Create a new MangaDexClient with the default reqwest::Client settings.

Examples

use reqwest::Client;

use mangadex_api::v5::MangaDexClient;

let client = MangaDexClient::default();