Crate thunderstore

A library for interacting with the Thunderstore API.

The main struct is Client, which provides methods for fetching, downloading and publishing packages. The easiest way to get up and running is to use the Client::new method, which creates a client with the default configuration. If you need more control over the client’s configuration, use the Client::builder method instead (see ClientBuilder).

Some methods, including uploading and submitting packages, require an API token to be set on the client. You can set this token using the ClientBuilder::with_token method.

Examples

#[tokio::main]
async fn main() -> thunderstore::Result<()> {
    let client = thunderstore::Client::builder()
        .with_token("tss_XXX")
        .build()?;

    let package = client.get_package(("Kesomannen", "GaleModManager")).await?;
    let _bytes = client.download(package.latest.ident).await?;

    client.publish_file(
        "CoolMod.zip",
        PackageMetadata::new("Kesomannen", ["lethal-company"])
            .with_global_categories(["tools"])
            .with_categories("lethal-company", ["serverside"])
    ).await?;
}

Modules

experimental

models

prelude

v1

Structs

Client

A client for interacting with the Thunderstore API.

ClientBuilder

A builder for configuring a Client instance.

PackageIdent

A unique identifier for a package, formatted as namespace-name.

VersionIdent

A unique identifier for a package version, formatted as namespace-name-version.

Enums

Error

An error that can occur when interacting with the API.

Traits

IntoPackageIdent

A fallible conversion to [Cow<'a, PackageIdent>].

IntoVersionIdent

A fallible conversion to [Cow<'a, VersionIdent>].

Type Aliases

Result

A Result alias where the error type is crate::Error.