Struct demostf_client::ApiClient

pub struct ApiClient { /* private fields */ }

Api client for demos.tf

Example

use demostf_client::{ListOrder, ListParams, ApiClient};

let client = ApiClient::new();

let demos = client.list(ListParams::default().with_order(ListOrder::Ascending), 1).await?;

for demo in demos {
    println!("{}: {}", demo.id, demo.name);
}

Implementations

impl ApiClient

pub const DEMOS_TF_BASE_URL: &'static str = "https://api.demos.tf/"

pub fn new() -> Self

Create an api client for the default demos.tf endpoint

pub fn with_base_url(base_url: impl IntoUrl) -> Result<Self, Error>

Create an api client using a different api endpoint

Errors

Returns an error when the provided base_url is not a valid url

pub fn with_base_url_and_timeout(
    base_url: impl IntoUrl,
    timeout: Duration
) -> Result<Self, Error>

Create an api client using a different api endpoint and timeout

Errors

Returns an error when the provided base_url is not a valid url

pub async fn list(
    &self,
    params: ListParams,
    page: u32
) -> Result<Vec<Demo>, Error>

List demos with the provided options

note that the pages start counting at 1

Example

use demostf_client::{ListOrder, ListParams};

let demos = client.list(ListParams::default().with_order(ListOrder::Ascending), 1).await?;

for demo in demos {
    println!("{}: {}", demo.id, demo.name);
}

pub async fn list_uploads(
    &self,
    uploader: SteamID,
    params: ListParams,
    page: u32
) -> Result<Vec<Demo>, Error>

List demos uploaded by a user with the provided options

note that the pages start counting at 1

Example

use demostf_client::{ListOrder, ListParams};

let client = ApiClient::default();
let demos = client.list_uploads(SteamID::from(76561198024494988), ListParams::default().with_order(ListOrder::Ascending), 1).await?;

for demo in demos {
    println!("{}: {}", demo.id, demo.name);
}

pub async fn get(&self, demo_id: u32) -> Result<Demo, Error>

Get the data for a single demo

Example

let demo = client.get(9).await?;

println!("{}: {}", demo.id, demo.name);
println!("players:");

for player in demo.players.unwrap_or_default() {
    println!("{}", player.user.name);
}

pub async fn get_user(&self, user_id: u32) -> Result<User, Error>

Get user info by id

Example

let user = client.get_user(1).await?;

println!("{} ({})", user.name, user.steam_id.steam3());

pub async fn search_users(&self, name: &str) -> Result<Vec<User>, Error>

Search for players by name

Example

let client = ApiClient::default();
let users = client.search_users("icewind").await?;

for user in users {
  println!("{} ({})", user.name, user.steam_id.steam3());
}

pub async fn get_chat(&self, demo_id: u32) -> Result<Vec<ChatMessage>, Error>

List demos with the provided options

Example

let chat = client.get_chat(447678).await?;

for message in chat {
    println!("{}: {}", message.user, message.message);
}

pub async fn set_url(
    &self,
    demo_id: u32,
    backend: &str,
    path: &str,
    url: &str,
    hash: [u8; 16],
    key: &str
) -> Result<(), Error>

pub async fn upload_demo(
    &self,
    file_name: String,
    body: Vec<u8>,
    red: String,
    blue: String,
    key: String
) -> Result<u32, Error>

Trait Implementations

impl Clone for ApiClient

fn clone(&self) -> ApiClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiClient

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

Formats the value using the given formatter.

impl Default for ApiClient

fn default() -> Self

Returns the “default value” for a type.