Struct trakt::sync::TraktApi

pub struct TraktApi { /* fields omitted */ }

The main struct which contains all requests

Methods

impl TraktApi

pub fn oauth_authorize(
    &self,
    client_id: &str,
    redirect_uri: &str,
    state: Option<&str>
) -> Result<()>

pub fn oauth_get_token(
    &self,
    code: &str,
    redirect_uri: &str
) -> Result<AuthenticationTokenResponse>

pub fn oauth_refresh_token(
    &self,
    refresh_token: &str,
    redirect_uri: &str
) -> Result<AuthenticationTokenResponse>

pub fn oauth_revoke_token(&self, token: &str) -> Result<()>

pub fn devices_authenticate(&self) -> Result<AuthenticationDevices>

pub fn get_token(
    &self,
    device_code: &str
) -> Result<AuthenticationTokenResponse>

impl TraktApi

pub fn calendar_all_shows(&self) -> CalendarRequest<CalendarShow>

pub fn calendar_my_shows<'a>(
    &'a self,
    access_token: &'a str
) -> CalendarRequest<'a, CalendarShow>

pub fn calendar_all_new_shows(&self) -> CalendarRequest<CalendarShow>

pub fn calendar_my_new_shows<'a>(
    &'a self,
    access_token: &'a str
) -> CalendarRequest<'a, CalendarShow>

pub fn calendar_all_season_premieres(&self) -> CalendarRequest<CalendarShow>

pub fn calendar_my_season_premieres<'a>(
    &'a self,
    access_token: &'a str
) -> CalendarRequest<'a, CalendarShow>

pub fn calendar_all_movies(&self) -> CalendarRequest<CalendarMovie>

pub fn calendar_my_movies<'a>(
    &'a self,
    access_token: &'a str
) -> CalendarRequest<'a, CalendarMovie>

pub fn calendar_all_dvd(&self) -> CalendarRequest<CalendarMovie>

pub fn calendar_my_dvd<'a>(
    &'a self,
    access_token: &'a str
) -> CalendarRequest<'a, CalendarMovie>

impl TraktApi

pub fn checkin(&self) -> Checkin

pub fn checkout(&self, access_token: &str) -> Result<()>

impl TraktApi

pub fn comment_create<'a>(
    &'a self,
    comment: &'a str
) -> CommentCreateRequest<'a>

pub fn comment(&self, id: u32) -> Result<Comment>

pub fn comment_update(
    &self,
    comment_id: u32,
    comment: String
) -> CommentPostRequest

pub fn comment_delete(&self, comment_id: u32, access_token: &str) -> Result<()>

pub fn replies(&self, comment_id: u32) -> PaginationRequest<Comment>

pub fn replies_post(
    &self,
    comment_id: u32,
    comment: String
) -> CommentPostRequest

pub fn comment_item(&self, comment_id: u32) -> Result<CommentItem>

pub fn comment_likes(&self, comment_id: u32) -> PaginationRequest<Like>

pub fn comment_like(&self, comment_id: u32, access_token: &str) -> Result<()>

pub fn comment_like_delete(
    &self,
    comment_id: u32,
    access_token: &str
) -> Result<()>

pub fn comments_trending(&self) -> CommentsRequest<CommentAndItem>

pub fn comments_recent(&self) -> CommentsRequest<CommentAndItem>

pub fn comments_updates(&self) -> CommentsRequest<CommentAndItem>

impl TraktApi

pub fn episode(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<Episode>

pub fn episode_full(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<FullEpisode>

pub fn episode_translations(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32,
    language: impl Display
) -> Result<Vec<Translation>>

pub fn episode_comments(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> PaginationRequest<Comment>

pub fn episode_lists(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32,
    f: impl FnOnce(ListFactory) -> ListFactory
) -> PaginationRequest<List>

pub fn episode_ratings(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<Ratings>

pub fn episode_stats(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<MediaStats>

pub fn episode_watching(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<Vec<User>>

pub fn episode_watching_full(
    &self,
    show_id: impl Display,
    season_number: u32,
    episode_number: u32
) -> Result<Vec<FullUser>>

impl TraktApi

pub fn lists_trending(&self) -> PaginationRequest<ListInfo>

pub fn lists_popular(&self) -> PaginationRequest<ListInfo>

impl TraktApi

pub fn movies_trending(&self) -> MoviesRequest<MovieInfo>

pub fn movies_popular(&self) -> MoviesRequest<Movie>

pub fn movies_played(&self, period: TimePeriod) -> MoviesRequest<WatchedMovie>

pub fn movies_watched(&self, period: TimePeriod) -> MoviesRequest<WatchedMovie>

pub fn movies_collected(
    &self,
    period: TimePeriod
) -> MoviesRequest<WatchedMovie>

pub fn movies_anticipated(&self) -> MoviesRequest<AnticipatedMovie>

pub fn movies_updates(&self) -> PaginationRequest<UpdatedMovie>

pub fn movie(&self, id: impl Display) -> Result<Movie>

pub fn movie_aliases(&self, id: impl Display) -> Result<Vec<Alias>>

pub fn movie_translations(
    &self,
    id: impl Display,
    language: impl Display
) -> Result<Vec<Translation>>

pub fn movie_comments(&self, id: impl Display) -> PaginationRequest<Comment>

pub fn movie_lists(
    &self,
    id: impl Display,
    f: impl FnOnce(ListFactory) -> ListFactory
) -> PaginationRequest<List>

pub fn movie_people(&self, id: impl Display) -> Result<People>

pub fn movie_ratings(&self, id: impl Display) -> Result<Ratings>

pub fn movie_related(&self, id: impl Display) -> PaginationRequest<Movie>

pub fn movie_stats(&self, id: impl Display) -> Result<MediaStats>

pub fn movie_watching(&self, id: impl Display) -> Result<Vec<User>>

impl TraktApi

pub fn people(&self, id: &str) -> Result<Person>

pub fn people_movie_credits(&self, id: &str) -> Result<Credits>

pub fn people_show_credits(&self, id: &str) -> Result<Credits>

pub fn people_lists(
    &self,
    id: &str,
    f: impl FnOnce(ListFactory) -> ListFactory
) -> Result<Vec<List>>

impl TraktApi

pub fn recommendations_movie(&self, access_token: &str) -> Result<Vec<Movie>>

pub fn recommendations_movie_hide(
    &self,
    id: impl Display,
    access_token: &str
) -> Result<()>

pub fn recommendations_show(&self, access_token: &str) -> Result<Vec<Movie>>

pub fn recommendations_show_hide(
    &self,
    id: impl Display,
    access_token: &str
) -> Result<()>

impl TraktApi

pub fn search(
    &self,
    item_type: SearchType,
    query: &str
) -> PaginationRequest<SearchResult>

pub fn id_lookup(
    &self,
    id_type: IdType,
    id: impl Display,
    item_type: Option<SearchItemType>
) -> Result<Vec<SearchResult>>

impl TraktApi

pub fn seasons(&self, show_id: impl Display) -> Result<Vec<Season>>

pub fn season(
    &self,
    show_id: impl Display,
    season_number: u32
) -> Result<Vec<Episode>>

pub fn season_comments(
    &self,
    show_id: impl Display,
    season_number: u32
) -> Result<Vec<Comment>>

pub fn season_lists(
    &self,
    show_id: impl Display,
    season_number: u32,
    f: impl FnOnce(ListFactory) -> ListFactory
) -> Result<Vec<List>>

pub fn season_ratings(
    &self,
    show_id: impl Display,
    season_number: u32
) -> Result<Ratings>

pub fn season_stats(
    &self,
    show_id: impl Display,
    season_number: u32
) -> Result<MediaStats>

pub fn season_watching(
    &self,
    show_id: impl Display,
    season_number: u32
) -> Result<Vec<User>>

impl TraktApi

pub fn shows_trending(&self) -> PaginationRequest<ShowInfo>

pub fn shows_popular(&self) -> PaginationRequest<Show>

pub fn shows_played(&self, period: TimePeriod) -> PaginationRequest<WatchedShow>

pub fn shows_watched(
    &self,
    period: TimePeriod
) -> PaginationRequest<WatchedShow>

pub fn shows_collected(
    &self,
    period: TimePeriod
) -> PaginationRequest<WatchedShow>

pub fn shows_anticipated(&self) -> PaginationRequest<AnticipatedShow>

pub fn shows_updates(&self) -> PaginationRequest<UpdatedShow>

pub fn show(&self, id: impl Display) -> Result<Show>

pub fn show_aliases(&self, id: impl Display) -> Result<Vec<Alias>>

pub fn show_translations(
    &self,
    id: impl Display,
    language: impl Display
) -> Result<Vec<Translation>>

pub fn show_comments(&self, id: impl Display) -> PaginationRequest<Comment>

pub fn show_lists(
    &self,
    id: impl Display,
    f: impl FnOnce(ListFactory) -> ListFactory
) -> PaginationRequest<List>

pub fn show_progress_collection(
    &self,
    id: impl Display,
    access_token: &str
) -> Result<CollectionProgress>

pub fn show_progress_watched(
    &self,
    id: impl Display,
    access_token: &str
) -> Result<WatchedProgress>

pub fn show_people(&self, id: impl Display) -> Result<People>

pub fn show_ratings(&self, id: impl Display) -> Result<Ratings>

pub fn show_related(&self, id: impl Display) -> PaginationRequest<Show>

pub fn show_stats(&self, id: impl Display) -> Result<MediaStats>

pub fn show_watching(&self, id: impl Display) -> Result<Vec<User>>

pub fn show_next_episode(&self, id: impl Display) -> Result<Option<Episode>>

pub fn show_last_episode(&self, id: impl Display) -> Result<Option<Episode>>

impl TraktApi

pub fn sync_last_activities(&self, access_token: &str) -> Result<LastActivities>

pub fn sync_playback(
    &self,
    item_type: WatchableType,
    access_token: &str
) -> Result<Vec<Playback>>

pub fn sync_playback_delete(
    &self,
    playback_id: u64,
    access_token: &str
) -> Result<()>

pub fn sync_collection_movie(
    &self,
    access_token: &str
) -> Result<Vec<CollectionMovie>>

pub fn sync_collection_show(
    &self,
    access_token: &str
) -> Result<Vec<CollectionShow>>

pub fn sync_collection_add(&self) -> SyncRequest<SyncAddResponse>

pub fn sync_collection_remove(&self) -> SyncRequest<SyncRemoveResponse>

pub fn sync_watched(
    &self,
    item_type: MediaType,
    access_token: &str
) -> Result<Vec<WatchedEntry>>

pub fn sync_history(
    &self,
    item_type: ItemType,
    start_at: DateTime<Utc>,
    end_at: DateTime<Utc>,
    access_token: &str
) -> PaginationRequest<HistoryItem>

pub fn sync_history_add(&self) -> SyncRequest<SyncAddResponse>

pub fn sync_history_remove(&self) -> SyncRequest<SyncRemoveResponse>

pub fn sync_ratings(
    &self,
    item_type: AllItemType,
    access_token: &str
) -> Result<Vec<Rating>>

pub fn sync_ratings_add(&self) -> SyncRequest<SyncAddResponse>

pub fn sync_ratings_remove(&self) -> SyncRequest<SyncRemoveResponse>

pub fn sync_watchlist(
    &self,
    item_type: Option<ItemType>,
    access_token: &str
) -> Result<Vec<ListItem>>

pub fn sync_watchlist_add(&self) -> SyncRequest<SyncAddResponse>

pub fn sync_watchlist_remove(&self) -> SyncRequest<SyncRemoveResponse>

impl TraktApi

pub fn user_settings(&self, access_token: &str) -> Result<Settings>

pub fn user_requests(&self, access_token: &str) -> Result<Vec<FollowRequest>>

pub fn user_request_approve(
    &self,
    id: u32,
    access_token: &str
) -> Result<FollowRequestApprove>

pub fn user_request_deny(&self, id: u32, access_token: &str) -> Result<()>

pub fn user_likes(
    &self,
    item_type: Option<LikeableType>,
    access_token: &str
) -> PaginationRequest<UserLike>

pub fn user_profile(
    &self,
    slug: &str,
    access_token: Option<&str>
) -> Result<User>

pub fn user_profile_full(
    &self,
    slug: &str,
    access_token: Option<&str>
) -> Result<FullUser>

pub fn user_collection_movies(
    &self,
    slug: &str,
    access_token: Option<&str>
) -> Result<Vec<CollectionMovie>>

pub fn user_collection_shows(
    &self,
    slug: &str,
    access_token: Option<&str>
) -> Result<Vec<CollectionShow>>

pub fn user_comments(
    &self,
    slug: &str,
    f: impl FnOnce(GetComments) -> GetComments,
    access_token: Option<&str>
) -> PaginationRequest<CommentAndItem>

impl TraktApi

Generic functions and simple requests

pub fn new(client_id: String, client_secret: Option<String>) -> TraktApi

Creates a new client client ID is needed client secret is optional if you need authorization

pub fn certifications(&self, ct: CertificationsType) -> Result<Certifications>

Get a Vec of all certifications, including names, slugs, and descriptions. Trakt API

Errors

Returns Error::Response if the response contains an unsuccessful status code

Returns Error::Connection if the connection failed

Returns Error::Serde if the response could not be deserialized

pub fn countries(&self, media_type: MediaType) -> Result<Vec<Country>>

Get a Vec of all countries, including names and codes. Trakt API

Errors

Returns Error::Response if the response contains an unsuccessful status code

Returns Error::Connection if the connection failed

Returns Error::Serde if the response could not be deserialized

pub fn genres(&self, media_type: MediaType) -> Result<Vec<Genre>>

Get a Vec of all genres, including names and slugs. Trakt API

Errors

Returns Error::Response if the response contains an unsuccessful status code

Returns Error::Connection if the connection failed

Returns Error::Serde if the response could not be deserialized

pub fn languages(&self, media_type: MediaType) -> Result<Vec<Language>>

Get a Vec of all languages, including names and codes. Trakt API

Errors

Returns Error::Response if the response contains an unsuccessful status code

Returns Error::Connection if the connection failed

Returns Error::Serde if the response could not be deserialized

pub fn networks(&self) -> Result<Vec<Network>>

Get a Vec of all TV networks, including the name. Trakt API

Errors

Returns Error::Response if the response contains an unsuccessful status code

Returns Error::Connection if the connection failed

Returns Error::Serde if the response could not be deserialized

pub fn into_async(self) -> TraktApi

Trait Implementations

impl PartialEq<TraktApi> for TraktApi

fn eq(&self, other: &TraktApi) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for TraktApi

fn clone(&self) -> TraktApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TraktApi

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

Formats the value using the given formatter.