Trait speedrun_api::api::RestClient

pub trait RestClient {
    type Error: Error + Send + Sync + 'static;

    fn rest_endpoint(&self, endpoint: &str) -> Result<Url, ApiError<Self::Error>>;
    fn has_api_key(&self) -> bool;
}

A trait representing a client which can communicate with speedrun.com via REST

Required Associated Types

type Error: Error + Send + Sync + 'static

The error that may occur for this client

Required Methods

fn rest_endpoint(&self, endpoint: &str) -> Result<Url, ApiError<Self::Error>>

Get the URL for the endpoint for the client.

This method adds the hostname for the target api.

fn has_api_key(&self) -> bool

If the client has an API key

Implementors

impl RestClient for SpeedrunApiClient

type Error = RestError

impl RestClient for SpeedrunApiClientAsync

type Error = RestError