Struct Client 

pub struct Client { /* private fields */ }

HTTP client for the mod.io API.

Implementations

impl Client

pub const fn get_terms(&self) -> GetTerms<'_>

Get text and links for user agreement and consent prior to authentication. [required: apikey]

See the mod.io docs for more information.

pub const fn request_code<'a>(&'a self, email: &'a str) -> EmailRequest<'a>

Request a security code be sent to the email of the user. [required: apikey]

pub const fn request_token<'a>( &'a self, security_code: &'a str, ) -> EmailExchange<'a>

Get the access token for a security code. [required: apikey]

pub const fn external_auth<T: Provider>( &self, external: T, ) -> ExternalAuth<'_, T>

Authenticate via external services (Steam, GOG, Switch, Xbox, Discord, Oculus, Google etc.).

See the mod.io docs for more information.

Examples

use modio::request::auth::external::Steam;
let response = client.external_auth(Steam::new("ticket")).await?;
let token = response.data().await?;

use modio::request::auth::external::PSN;
let response = client.external_auth(PSN::new("auth_code")).env(1).await?;
let token = response.data().await?;

use modio::request::auth::external::Discord;
let response = client
    .external_auth(Discord::new("token"))
    .email("john@example.com")
    .await?;
let token = response.data().await?;

pub const fn logout(&self) -> Logout<'_>

Log out by revoking the current access token.

impl Client

pub const fn get_games(&self) -> GetGames<'_>

Get all games.

pub const fn get_game(&self, game_id: GameId) -> GetGame<'_>

Get a game.

pub const fn get_game_stats(&self, game_id: GameId) -> GetGameStats<'_>

Return the statistics for a game.

pub const fn get_game_tags(&self, game_id: GameId) -> GetGameTags<'_>

Return the tag options for a game.

pub const fn add_game_tags<'a>( &'a self, game_id: GameId, name: &'a str, kind: TagType, tags: &'a [&'a str], ) -> AddGameTags<'a>

Add tags which can applied to mods. [required: token]

pub const fn delete_game_tags<'a>( &'a self, game_id: GameId, name: &'a str, ) -> DeleteGameTags<'a>

Delete an entire group of tags or individual tags. [required: token]

pub const fn rename_game_tag<'a>( &'a self, game_id: GameId, from: &'a str, to: &'a str, ) -> RenameGameTag<'a>

Rename an existing tag, updating all mods in the progress. [required: token]

pub const fn add_game_media(&self, game_id: GameId) -> AddGameMedia<'_>

Add new media to a game. [required: token]

impl Client

pub const fn get_mods(&self, game_id: GameId) -> GetMods<'_>

Get all mods for a game.

See Filters and sorting

Examples

use modio::request::filter::prelude::*;
use modio::request::mods::filters::Name;
use modio::types::id::Id;

let list = client
    .get_mods(Id::new(51))
    .filter(Name::eq("the-x-com-files"))
    .await?
    .data()
    .await?;

pub const fn get_mod(&self, game_id: GameId, mod_id: ModId) -> GetMod<'_>

Get the Modio mod object that this refers to.

pub fn add_mod<'a>( &'a self, game_id: GameId, name: &'a str, summary: &'a str, logo: impl AsRef<Path>, ) -> AddMod<'a>

Add a mod and return the newly created Modio mod object. [required: token]

pub const fn edit_mod(&self, game_id: GameId, mod_id: ModId) -> EditMod<'_>

Edit details for a mod. [required: token]

pub const fn delete_mod(&self, game_id: GameId, mod_id: ModId) -> DeleteMod<'_>

Delete a mod. [required: token]

pub const fn add_mod_media( &self, game_id: GameId, mod_id: ModId, ) -> AddModMedia<'_>

Add new media to a mod. [required: token]

pub const fn delete_mod_media( &self, game_id: GameId, mod_id: ModId, ) -> DeleteModMedia<'_>

Delete media from a mod. [required: token]

pub const fn reorder_mod_media( &self, game_id: GameId, mod_id: ModId, ) -> ReorderModMedia<'_>

Reorder the media of a mod. [required: token]

pub const fn subscribe_to_mod( &self, game_id: GameId, mod_id: ModId, ) -> SubscribeToMod<'_>

Subscribe the authenticated user to a mod. [required: token]

pub const fn unsubscribe_from_mod( &self, game_id: GameId, mod_id: ModId, ) -> UnsubscribeFromMod<'_>

Unsubscribe the authenticated user from a mod. [required: token]

pub const fn rate_mod( &self, game_id: GameId, mod_id: ModId, ) -> SubmitModRating<'_>

Submit a rating for a mod. [required: token]

pub const fn get_mod_team_members( &self, game_id: GameId, mod_id: ModId, ) -> GetModTeamMembers<'_>

Get all users that are part of a mod team.

impl Client

pub const fn get_mod_tags( &self, game_id: GameId, mod_id: ModId, ) -> GetModTags<'_>

Get all tags for a mod.

pub const fn add_mod_tags<'a>( &'a self, game_id: GameId, mod_id: ModId, tags: &'a [&'a str], ) -> AddModTags<'a>

Add tags to a mod. [required: token]

pub const fn delete_mod_tags<'a>( &'a self, game_id: GameId, mod_id: ModId, tags: &'a [&'a str], ) -> DeleteModTags<'a>

Delete tags from a mod. [required: token]

impl Client

pub const fn get_mods_events(&self, game_id: GameId) -> GetModsEvents<'_>

Get all mod events for a game sorted by latest first.

pub const fn get_mods_stats(&self, game_id: GameId) -> GetModsStats<'_>

Get all mod statistics for a game.

pub const fn get_mod_events( &self, game_id: GameId, mod_id: ModId, ) -> GetModEvents<'_>

Get the event log for a mod, showing changes made sorted by latest first.

pub const fn get_mod_stats( &self, game_id: GameId, mod_id: ModId, ) -> GetModStats<'_>

Get the statistics for a mod.

impl Client

pub const fn get_mod_metadata( &self, game_id: GameId, mod_id: ModId, ) -> GetModMetadata<'_>

Get all metadata key value pairs.

pub const fn add_mod_metadata( &self, game_id: GameId, mod_id: ModId, metadata: MetadataMap, ) -> AddModMetadata<'_>

Add metadata for a mod as key value pairs. [required: token]

pub const fn delete_mod_metadata( &self, game_id: GameId, mod_id: ModId, metadata: MetadataMap, ) -> DeleteModMetadata<'_>

Delete metadata key value pairs for a mod. [required: token]

impl Client

pub const fn get_mod_dependencies( &self, game_id: GameId, mod_id: ModId, ) -> GetModDependencies<'_>

Get all dependencies a mod has selected.

pub const fn add_mod_dependencies<'a>( &'a self, game_id: GameId, mod_id: ModId, deps: &'a [ModId], ) -> AddModDependencies<'a>

Add mod dependencies required by a mod. [required: token]

pub const fn delete_mod_dependencies<'a>( &'a self, game_id: GameId, mod_id: ModId, deps: &'a [ModId], ) -> DeleteModDependencies<'a>

Delete mod dependencies a mod requires. [required: token]

impl Client

pub const fn get_mod_comments( &self, game_id: GameId, mod_id: ModId, ) -> GetModComments<'_>

Get all comments posted on a mod’s profile.

pub const fn get_mod_comment( &self, game_id: GameId, mod_id: ModId, comment_id: CommentId, ) -> GetModComment<'_>

Get a comment posted on a mod’s profile.

pub const fn add_mod_comment<'a>( &'a self, game_id: GameId, mod_id: ModId, content: &'a str, ) -> AddModComment<'a>

Add a comment on a mod’s profile. [required: token]

pub const fn edit_mod_comment<'a>( &'a self, game_id: GameId, mod_id: ModId, comment_id: CommentId, content: &'a str, ) -> EditModComment<'a>

Edit a comment on a mod’s profile. [required: token]

pub const fn delete_mod_comment( &self, game_id: GameId, mod_id: ModId, comment_id: CommentId, ) -> DeleteModComment<'_>

Delete a comment from a mod’s profile. [required: token]

pub const fn update_mod_comment_karma( &self, game_id: GameId, mod_id: ModId, comment_id: CommentId, ) -> UpdateModCommentKarma<'_>

Update the karma rating for a comment. [required: token]

impl Client

pub const fn get_files(&self, game_id: GameId, mod_id: ModId) -> GetFiles<'_>

Get all files from a mod.

pub const fn get_file( &self, game_id: GameId, mod_id: ModId, file_id: FileId, ) -> GetFile<'_>

Get a file from a mod.

pub const fn add_file(&self, game_id: GameId, mod_id: ModId) -> AddFile<'_>

Add file to a mod. [required: token]

pub const fn edit_file( &self, game_id: GameId, mod_id: ModId, file_id: FileId, ) -> EditFile<'_>

Edit the details of a published file. [required: token]

pub const fn delete_file( &self, game_id: GameId, mod_id: ModId, file_id: FileId, ) -> DeleteFile<'_>

Delete a mod file. [required: token]

pub const fn manage_platform_status( &self, game_id: GameId, mod_id: ModId, file_id: FileId, ) -> ManagePlatformStatus<'_>

Manage the platform status of a particular mod file. [required: token]

impl Client

pub const fn get_multipart_upload_sessions( &self, game_id: GameId, mod_id: ModId, ) -> GetMultipartUploadSessions<'_>

Get all upload sessions. [required: token]

pub const fn create_multipart_upload_session<'a>( &'a self, game_id: GameId, mod_id: ModId, filename: &'a str, ) -> CreateMultipartUploadSession<'a>

Create a new multipart upload session. [required: token]

pub const fn get_multipart_upload_parts( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, ) -> GetMultipartUploadParts<'_>

Get the upload parts of the session. [required: token]

pub const fn add_multipart_upload_part<S>( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, range: ContentRange, stream: S, ) -> AddMultipartUploadPart<'_, S>

where S: TryStream + Send + 'static, S::Ok: Into<Bytes>, S::Error: Into<Box<dyn Error + Send + Sync>>,

Add a new part to an existing upload session. [required: token]

pub const fn complete_multipart_upload_session( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, ) -> CompleteMultipartUploadSession<'_>

Complete an active upload session after uploading all parts with Client::add_multipart_upload_part. [required: token]

pub const fn delete_multipart_upload_session( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, ) -> DeleteMultipartUploadSession<'_>

Terminate an active upload session. [required: token]

pub const fn add_multipart_upload_file( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, ) -> AddMultipartUploadFile<'_>

Finalize the upload with file details. [required: token]

Example

use modio::types::files::File;
use modio::types::id::Id;

let game_id = Id::new(51);
let mod_id = Id::new(1041);
let UploadSession { id: upload_id, .. } = session;

let file: File = client
    .add_multipart_upload_file(game_id, mod_id, upload_id)
    .version("1.0")
    .active(true)
    .await?
    .data()
    .await?;

impl Client

pub const fn get_authenticated_user(&self) -> GetAuthenticatedUser<'_>

Get the authenticated user details. [required: token]

pub const fn get_user_games(&self) -> GetUserGames<'_>

Get all games the authenticated user added or is a team member of. [required: token]

pub const fn get_user_mods(&self) -> GetUserMods<'_>

Get all mods the authenticated user added or is a team member of. [required: token]

pub const fn get_user_files(&self) -> GetUserFiles<'_>

Get all mod files the authenticated user uploaded. [required: token]

pub const fn get_user_ratings(&self) -> GetUserRatings<'_>

Get all mod ratings the authenticated user submitted. [required: token]

pub const fn get_user_subscriptions(&self) -> GetUserSubscriptions<'_>

Get all mods the authenticated user is subscribed to. [required: token]

pub const fn get_user_events(&self) -> GetUserEvents<'_>

Get events that have been fired specific to the user. [required: token]

impl Client

pub const fn get_muted_users(&self) -> GetMutedUsers<'_>

Get all user muted by the authenticated user. [required: token]

pub const fn mute_user(&self, user_id: UserId) -> MuteUser<'_>

Mute a user. [required: token]

pub const fn unmute_user(&self, user_id: UserId) -> UnmuteUser<'_>

Unmute a previously muted user. [required: token]

impl Client

pub fn report<'a>( &'a self, resource: &'a str, id: ResourceId, kind: u8, summary: &'a str, ) -> SubmitReport<'a>

Report a resource (game, guide, mod or user) on mod.io.

impl Client

pub fn builder(api_key: String) -> Builder

Create a new builder with an API key.

pub fn api_key(&self) -> &str

Retrieve the API key used by the client.

pub fn token(&self) -> Option<&str>

Retrieve the token used by the client.

pub fn with_token(&self, token: String) -> Self

Create a new client from the current instance with the given token.

Trait Implementations

impl Download for Client

fn download<A>(&self, action: A) -> Downloader<'_, Init<'_>>

where DownloadAction: From<A>,

Returns Downloader for saving to file or retrieving the data chunked as Bytes.

impl MultipartUpload for Client

fn upload<'a>( &'a self, game_id: GameId, mod_id: ModId, filename: &'a str, ) -> MultipartUploader<'a, Init<'a>>

Returns MultipartUploader for uploading files in multiple parts.

fn upload_for( &self, game_id: GameId, mod_id: ModId, upload_id: UploadId, ) -> MultipartUploader<'_, Started<'_>>