Struct ConnectionBuilder

pub struct ConnectionBuilder<'a> { /* private fields */ }

Builder struct for an APIConnection.

You would use it like this:

extern crate brawlhalla;
use brawlhalla::ConnectionBuilder;

#[tokio::main]
async fn main() -> Result<(), brawlhalla::APIError> {
    let steamid: u64 = 42069;
    ConnectionBuilder::default()
    .with_apikey("your_apikey")
    .build()
    .search_by_steam_id(steamid)
    .await?;
    println!("{}", steamid);
    Ok(())
}

Implementations

impl<'a> ConnectionBuilder<'a>

pub fn with_apikey(self, apikey: &'a str) -> Self

Configures an API Key for your builder

pub fn with_apiurl(self, apiurl: &'a str) -> Self

Configures the API URL for the builder. You will probably never need this function.

pub fn build(self) -> APIConnection

Builds an APIConnection struct from your builder.

pub fn new(apikey: &'a str, apiurl: &'a str) -> Self

This constructor is probably not what you want, use ConnectionBuilder::default() instead. Creates a builder struct with a custom API URL. This allows you to call any API that works like the official Brawlhalla API.

Trait Implementations

impl<'a> Default for ConnectionBuilder<'a>

fn default() -> Self

The default constructor for the builder. This is probably the constructor you want to use.