Struct modio::Modio

pub struct Modio { /* fields omitted */ }

Endpoint interface to interacting with the mod.io API.

Implementations

impl Modio

pub fn builder<C: Into<Credentials>>(credentials: C) -> Builder

Constructs a new Builder to configure a Modio client.

This is the same as Builder::new(credentials).

pub fn new<C>(credentials: C) -> Result<Self> where
    C: Into<Credentials>, 

Create an endpoint to https://api.mod.io/v1.

pub fn host<H, C>(host: H, credentials: C) -> Result<Self> where
    H: Into<String>,
    C: Into<Credentials>, 

Create an endpoint to a different host.

pub fn with_credentials<CR>(&self, credentials: CR) -> Self where
    CR: Into<Credentials>, 

Return an endpoint with new credentials.

pub fn with_token<T>(&self, token: T) -> Self where
    T: Into<Token>, 

Return an endpoint with a new token.

pub fn auth(&self) -> Auth

Return a reference to an interface for requesting access tokens.

pub fn games(&self) -> Games

Return a reference to an interface that provides access to game information.

pub fn game(&self, game_id: u32) -> GameRef

Return a reference to a game.

pub fn mod_(&self, game_id: u32, mod_id: u32) -> ModRef

Return a reference to a mod.

pub fn download<A>(&self, action: A) -> Downloader where
    DownloadAction: From<A>, 

Returns Downloader for saving to file or retrieving the data via Stream.

The download fails with modio::download::Error as source if a primary file, a specific file or a specific version is not found.

Example

use futures_util::{future, TryStreamExt};
use modio::download::{DownloadAction, ResolvePolicy};

// Download the primary file of a mod.
let action = DownloadAction::Primary {
    game_id: 5,
    mod_id: 19,
};
modio.download(action).save_to_file("mod.zip").await?;

// Download the specific file of a mod.
let action = DownloadAction::File {
    game_id: 5,
    mod_id: 19,
    file_id: 101,
};
modio.download(action).save_to_file("mod.zip").await?;

// Download the specific version of a mod.
// if multiple files are found then the latest file is downloaded.
// Set policy to `ResolvePolicy::Fail` to return with
// `modio::download::Error::MultipleFilesFound` as source error.
let action = DownloadAction::Version {
    game_id: 5,
    mod_id: 19,
    version: "0.1".to_string(),
    policy: ResolvePolicy::Latest,
};
modio
    .download(action)
    .stream()
    .try_for_each(|bytes| {
        println!("Bytes: {:?}", bytes);
        future::ok(())
    })
    .await?;

pub fn user(&self) -> Me

Return a reference to an interface that provides access to resources owned by the user associated with the current authentication credentials.

pub fn reports(&self) -> Reports

Return a reference to an interface to report games, mods and users.

Trait Implementations

impl Clone for Modio

pub fn clone(&self) -> Modio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Modio

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

Formats the value using the given formatter.