pub struct AnimeApiClient<State = None> { /* private fields */ }
Expand description

The AnimeApiClient provides functions for interacting with the various anime and user animelist MAL API endpoints. The accessible endpoints vary depending on if the AnimeApiClient was constructed from a MalClientId or an OauthClient.

Keep in mind that constructing an AnimeApiClient from an OauthClient provides more access to the MAL API than from a MalClientId. Check the MAL API documentation to view which endpoints require an OauthClient versus a MalClientId to see which one is most appropriate for your use case.

§Example

use dotenvy;
use mal_api::oauth::MalClientId;
use mal_api::prelude::*;

#[tokio::main]
async fn main() {
    dotenvy::dotenv().ok();

    let client_id = MalClientId::from_env().unwrap();
    let api_client = AnimeApiClient::from(&client_id);
    let common_fields = mal_api::anime::all_common_fields();
    let detail_fields = mal_api::anime::all_detail_fields();

    // Using the builder pattern for building the query
    let query = GetAnimeList::builder("One Piece")
        .fields(&common_fields)
        .build()
        .unwrap();
    let response = api_client.get_anime_list(&query).await;
    if let Ok(response) = response {
        println!("Received response: {}\n", response);
        for entry in response.data.iter() {
            println!("Id: {}", entry.node.id);
        }
    }

    let query = GetAnimeDetails::builder(9969)
        .fields(&detail_fields)
        .build()
        .unwrap();
    let response = api_client.get_anime_details(&query).await;
    if let Ok(response) = response {
        println!("Received response: {}\n", response);
    }
}

Implementations§

source§

impl AnimeApiClient<Client>

source

pub async fn get_user_anime_list( &self, query: &GetUserAnimeList ) -> Result<AnimeList, AnimeApiError>

Get a users anime list

You cannot get the anime list of @me with a ClientId AnimeApiClient

Corresponds to the Get user anime list endpoint

source§

impl AnimeApiClient<Oauth>

source

pub async fn get_suggested_anime( &self, query: &GetSuggestedAnime ) -> Result<SuggestedAnime, AnimeApiError>

Get a list of suggested anime

Corresponds to the Get suggested anime endpoint

source

pub async fn get_user_anime_list( &self, query: &GetUserAnimeList ) -> Result<AnimeList, AnimeApiError>

Get a users Anime list

You can get the anime list of @me with an OauthClient AnimeApiClient

Corresponds to the Get user anime list endpoint

source

pub async fn update_anime_list_status( &self, query: &UpdateMyAnimeListStatus ) -> Result<AnimeListStatus, AnimeApiError>

Update the status of an anime for the OAuth user’s anime list

Corresponds to the Update my anime list status endpoint

source

pub async fn delete_anime_list_item( &self, query: &DeleteMyAnimeListItem ) -> Result<(), AnimeApiError>

Delete an anime entry from the OAuth user’s anime list

Corresponds to the Delete my anime list item endpoint

Trait Implementations§

source§

impl<State: Clone> Clone for AnimeApiClient<State>

source§

fn clone(&self) -> AnimeApiClient<State>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<State: Debug> Debug for AnimeApiClient<State>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<State = None> !RefUnwindSafe for AnimeApiClient<State>

§

impl<State> Send for AnimeApiClient<State>
where State: Send,

§

impl<State> Sync for AnimeApiClient<State>
where State: Sync,

§

impl<State> Unpin for AnimeApiClient<State>
where State: Unpin,

§

impl<State = None> !UnwindSafe for AnimeApiClient<State>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more