Struct lib_mal::MALClient

pub struct MALClient {
    pub need_auth: bool,
    // some fields omitted
}

Exposes all of the API functions for the MyAnimeList API

With the exception of all the manga-related funcitons which haven’t been implemented yet

Example

 use lib_mal::MALClient;
 let client = MALClient::new([YOUR_SECRET_HERE]).await;
 //--do authorization stuff before accessing the funcitons--//

 //Gets the details with all fields for Mobile Suit Gundam
 let anime = client.get_anime_details(80, None).await.expect("Couldn't get anime details");
 //You should actually handle the potential error
 println!("Title: {} | Started airing: {} | Finished airing: {}",
     anime.show.title,
     anime.start_date.unwrap(),
     anime.end_date.unwrap());

Fields

need_auth: bool

Implementations

impl MALClient

pub async fn new(
    secret: &str,
    caching: bool,
    cache_dir: Option<PathBuf>
) -> Self

Creates the client and fetches the MAL tokens from the cache if available. If caching is fasle or cache_dir is None the user will have to log in at the start of every session.

When created client will attempt to refresh the access_token if it has expired

pub fn get_auth_parts(&self) -> (String, String, String)

Returns the auth URL and code challenge which will be needed to authorize the user.

Example

     use lib_mal::MALClient;

     let redirect_uri = "http://localhost:2525";//<-- example uri
     let client = MALClient::new([YOUR_SECRET_HERE]).await;
     let (url, challenge, state) = client.get_auth_parts();
     println!("Go here to log in: {}", url);
     client.auth(&redirect_uri, &challenge, &state).await.expect("Unable to log in");

pub async fn auth(
    &mut self,
    callback_url: &str,
    challenge: &str,
    state: &str
) -> Result<(), String>

Listens for the OAuth2 callback from MAL on callback_url, which is the redirect_uri registered when obtaining the API token from MAL. Only HTTP URIs are supported right now.

For now only applications with a single registered URI are supported, having more than one seems to cause issues with the MAL api itself

Example

     use lib_mal::MALClient;

     let redirect_uri = "localhost:2525";//<-- example uri,
     //appears as "http://localhost:2525" in the API settings
     let client = MALClient::new([YOUR_SECRET_HERE]).await;
     let (url, challenge, state) = client.get_auth_parts(&redirect_uri);
     println!("Go here to log in: {}", url);
     client.auth(&redirect_uri, &challenge, &state).await.expect("Unable to log in");

pub async fn get_anime_list(
    &self,
    query: &str,
    limit: Option<u8>
) -> Result<AnimeList, String>

Gets a list of anime based on the query string provided limit defaults to 100 if None

pub async fn get_anime_details(
    &self,
    id: u32,
    fields: Option<Vec<AnimeField>>
) -> Result<AnimeDetails, String>

Gets the deatils for an anime by the show’s ID. Only returns the fields specified in the fields parameter

Returns all fields when supplied None

pub async fn get_anime_ranking(
    &self,
    ranking_type: RankingType,
    limit: Option<u8>
) -> Result<AnimeList, String>

Gets a list of anime ranked by RankingType

limit defaults to the max of 100 when None

pub async fn get_seasonal_anime(
    &self,
    season: Season,
    year: u32,
    limit: Option<u8>
) -> Result<AnimeList, String>

Gets the anime for a given season in a given year

limit defaults to the max of 100 when None

pub async fn get_suggested_anime(
    &self,
    limit: Option<u8>
) -> Result<AnimeList, String>

Returns the suggested anime for the current user. Can return an empty list if the user has no suggestions.

pub async fn update_user_anime_status<T: Params>(
    &self,
    id: u32,
    update: T
) -> Result<ListStatus, String>

Adds an anime to the list, or updates the element if it already exists

pub async fn get_user_anime_list(&self) -> Result<AnimeList, String>

Returns the user’s full anime list as an AnimeList struct. If the request fails for any reason, an Err object with a string describing the error is returned instead

pub async fn delete_anime_list_item(&self, id: u32) -> Result<(), String>

Deletes the anime with id from the user’s anime list

Returns 404 if the id isn’t in the list.

pub async fn get_forum_boards(&self) -> Result<ForumBoards, String>

Returns a vector of HashMaps that represent all the forum boards on MAL

pub async fn get_forum_topic_detail(
    &self,
    topic_id: u32,
    limit: Option<u8>
) -> Result<TopicDetails, String>

pub async fn get_forum_topics(
    &self,
    board_id: Option<u32>,
    subboard_id: Option<u32>,
    query: Option<String>,
    topic_user_name: Option<String>,
    user_name: Option<String>,
    limit: Option<u32>
) -> Result<ForumTopics, String>

pub async fn get_my_user_info(
    &self,
    fields: Option<&str>
) -> Result<User, String>

Gets the details for the current user

fields defaults to anime_statistics if None