Struct furse::Furse

pub struct Furse { /* private fields */ }

An instance of the API to invoke API calls on

To initialise this container,

let curseforge = Furse::new(env!("CURSEFORGE_API_KEY"));
// Use the instance to call the API
let terralith_mod = curseforge.get_mod(513688).await?;

Implementations

impl Furse

pub async fn get_mod_files(&self, mod_id: ID) -> Result<Vec<File>, Error>

Get the files of mod with mod_id

Example:

// Get the Terralith mod's files
let terralith_files = curseforge.get_mod_files(513688).await?;
// Check that the latest file is downloadable
assert!(terralith_files[0].is_available);

pub async fn get_mod_file(&self, mod_id: ID, file_id: ID) -> Result<File, Error>

Get the file with file_id of mod with mod_id

Example:

// Get the Terralith mod's v2.0.12 file
let terralith_file = curseforge.get_mod_file(513688, 3606078).await?;
// Check that it contains the version in the file name
assert!(terralith_file.file_name.contains("v2.0.12"));

pub async fn get_mod_file_changelog(
    &self,
    mod_id: ID,
    file_id: ID
) -> Result<String, Error>

Get the changelog of the file with file_id of mod with mod_id

Example:

// Get the Terralith mod's v2.0.12 file's changelog
let terralith_file_changelog = curseforge.get_mod_file_changelog(513688, 3606078).await?;
// This update had huge performance updates so check that that is mentioned in the changelog
assert!(terralith_file_changelog.contains("performance"));

pub async fn file_download_url(
    &self,
    mod_id: ID,
    file_id: ID
) -> Result<Url, Error>

Get the download URL of the file with file_id of mod with mod_id

Example:

// Get information about the file
let terralith_mod_file = curseforge.get_mod_file(513688, 3606078).await?;
// Get the file's download url
let download_url = curseforge.file_download_url(513688, 3606078).await?;
// They should be the same url
assert!(Some(download_url.to_string()) == terralith_mod_file.download_url);

impl Furse

pub async fn get_mod(&self, mod_id: ID) -> Result<Mod, Error>

Get mod with ID mod_id

Example:

// Get the Terralith mod
let terralith_mod = curseforge.get_mod(513688).await?;
// Check that it is made by Starmute
assert!(terralith_mod.authors[0].name == "Starmute");

pub async fn get_mod_description(&self, mod_id: ID) -> Result<String, Error>

Get the description of mod with ID mod_id

Example:

// Get the Terralith mod's description
let terralith_mod_description = curseforge.get_mod_description(513688).await?;
// The description would obviously contains the mod's name
assert!(terralith_mod_description.contains("Terralith"));

impl Furse

pub fn new(api_key: &str) -> Self

Create a new API instance

api_key should be a CurseForge API key. You can obtain one by applying here

let curseforge = Furse::new(env!("CURSEFORGE_API_KEY"));

Trait Implementations

impl Clone for Furse

fn clone(&self) -> Furse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Furse

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

Formats the value using the given formatter.