Struct tvdb::raw::Tvdb

pub struct Tvdb<'a> {
    pub key: String,
    /* private fields */
}

Main interface

Fields

key: String

Your API key from TheTVDB.com

Implementations

impl<'a> Tvdb<'a>

pub fn new<S>(key: S) -> Tvdb<'a>where
    S: Into<String>,

Initalise API with the given API key. A key can be acquired via the API Key Registration page

pub fn login(&self) -> TvdbResult<bool>

Authenticate with TheTVDB, storing the JWT token internally for use by other methods.

pub fn set_http_client(&mut self, client: &'a dyn RequestClient)

Sets a custom client (implementation of RequestClient) used to perform HTTP requests

pub fn search(
    &self,
    name: Option<&str>,
    imdb_id: Option<&str>
) -> TvdbResult<SeriesSearchResult>

Search for series by name or IMDB ID https://api.thetvdb.com/swagger#!/Search/get_search_series

pub fn episode<E>(&self, id: E) -> TvdbResult<EpisodeRecordResult>where
    E: Into<EpisodeId>,

Full information about given episode https://api.thetvdb.com/swagger#!/Episodes/get_episodes_id

pub fn series_episodes<S>(
    &self,
    id: S,
    page: u32
) -> TvdbResult<SeriesEpisodesResult>where
    S: Into<SeriesId>,

All episodes for given series

Trait Implementations

impl<'a> Clone for Tvdb<'a>

fn clone(&self) -> Tvdb<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Tvdb<'a>

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

Formats the value using the given formatter.