Crate tasvideos_api_rs

Expand description

API Wrapper for the TASVideos API.

This crate provides synchronous functions for each supported endpoint of the API.

All requests can be used without an API key, however, the [USER_AGENT] string should be set before making any requests.

Structs§

Game: Represents a TASVideos game.
GameVersion: Represents a TASVideos game version (e.g. ROM).
Publication: Represents a TASVideos movie publication.
Submission: Represents a TASVideos movie submission.
System: Represents a gaming system (e.g. GBA, N64, Genesis, etc.) used by TASVideos.
SystemFrameRate: Describes a possible framerate for a gaming system.

Enums§

Error
Filter: Some endpoints can use these filters to refine what data is returned.

Constants§

MAX_PAGE_LENGTH

Functions§

get: Creates a GET request builder for the TASVideos API.
get_game: Executes a GET request to the /Games/{id} endpoint to retrieve a specific game.
get_games: Executes a GET request to the /Games endpoint to retrieve a list of games.
get_games_all: Executes one or more GET requests to the /Games endpoint to retreive all available games.
get_publication: Executes a GET request to the /Publications/{id} endpoint to retrieve a specific publication.
get_publication_movie: Attempts to download the publication’s movie file.
get_publications: Executes a GET request to the /Publications endpoint to retrieve a list of publications.
get_publications_all: Executes one or more GET requests to the /Publications endpoint to retreive all available publications.
get_submission: Executes a GET request to the /Submissions/{id} endpoint to retrieve a specific submission.
get_submission_movie: Attempts to download the submission’s movie file.
get_submissions: Executes a GET request to the /Submissions endpoint to retrieve a list of submissions.
get_submissions_all: Executes one or more GET requests to the /Submissions endpoint to retreive all available submissions.
get_system: Executes a GET request to the /Systems/{id} endpoint to retrieve a specific system.
get_systems: Executes a GET request to the /Systems endpoint to retrieve a list of all systems.
get_userfile: Attempts to download a userfile.
set_user_agent: Sets the User-Agent header used in all API requests.

Type Aliases§