Struct BBApi

pub struct BBApi(/* private fields */);

BattleBit API Struct

Implementations

impl BBApi

pub fn new() -> BBApi

Shorthand for BBApi::Default()
Creates a new BBApi with the default URL

Examples found in repository

examples/serverlist.rs (line 4)

fn main() {
    let api = BBApi::new();
    let server_list = api.server_list()
        .expect("Retrieving server list");

    server_list.into_iter().for_each(|server| {
        println!("{} [{}, {}, {}] ({}, {}, {})", 
            server.name(), 
            server.gamemode(), 
            server.map(),
            server.map_size(),
            server.hz(), 
            server.anti_cheat(),
            server.build()
        )
    });
}

examples/top_leaderboard.rs (line 29)

fn main() {
    let api = BBApi::new();
    let lb = api.leaderboard()
        .expect("Retrieving leaderboard");

    print_clan(lb.top_clans());

    print_player(lb.most_kills(), "Most kills", "Kills");
    print_player(lb.most_roadkills(), "Most roadkills", "Roadkills");
    print_player(lb.longest_kills(), "Longest kill", "Meters");

    print_player(lb.most_xp(), "Most XP", "XP");
    print_player(lb.most_heals(), "Most heal", "HP");
    print_player(lb.most_revives(), "Most revives", "Revives");

    print_player(lb.most_objectives_complete(), "Most objectives", "Objectives");

    print_player(lb.most_vehicles_destroyed(), "Vehicles destroyed", "Vehicles");
    print_player(lb.most_vehicle_repairs(), "Vehicle repairs", "Repairs");
}

examples/serverlist_unknown.rs (line 4)

fn main() {
    let api = BBApi::new();

    let server_list = api.server_list()
        .expect("Retrieving server list");

    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
        .into_iter()
        .filter(|server| server.has_unknown())
        .collect();

    if servers_with_unknown.is_empty() {
        println!("No servers with unknown fields found!")
    } else {
        servers_with_unknown.iter().for_each(|server| {
            println!("{} [{}, {}, {}] ({}, {}, {})", 
                server.name(), 
                server.gamemode(), 
                server.map(),
                server.map_size(),
                server.hz(), 
                server.anti_cheat(),
                server.build()
            )
        });
    }
}

pub fn with_url(url: Url) -> BBApi

Creates a new BBApi with the given URL

pub fn server_list(&self) -> Result<Vec<ServerData>, Error>

Fetches the server list and puts it into a Vec<ServerData>

Examples found in repository

examples/serverlist.rs (line 5)

fn main() {
    let api = BBApi::new();
    let server_list = api.server_list()
        .expect("Retrieving server list");

    server_list.into_iter().for_each(|server| {
        println!("{} [{}, {}, {}] ({}, {}, {})", 
            server.name(), 
            server.gamemode(), 
            server.map(),
            server.map_size(),
            server.hz(), 
            server.anti_cheat(),
            server.build()
        )
    });
}

examples/serverlist_unknown.rs (line 6)

fn main() {
    let api = BBApi::new();

    let server_list = api.server_list()
        .expect("Retrieving server list");

    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
        .into_iter()
        .filter(|server| server.has_unknown())
        .collect();

    if servers_with_unknown.is_empty() {
        println!("No servers with unknown fields found!")
    } else {
        servers_with_unknown.iter().for_each(|server| {
            println!("{} [{}, {}, {}] ({}, {}, {})", 
                server.name(), 
                server.gamemode(), 
                server.map(),
                server.map_size(),
                server.hz(), 
                server.anti_cheat(),
                server.build()
            )
        });
    }
}

pub fn leaderboard(&self) -> Result<Leaderboard, Error>

Fetches the leaderboard.

Examples found in repository

examples/top_leaderboard.rs (line 30)

fn main() {
    let api = BBApi::new();
    let lb = api.leaderboard()
        .expect("Retrieving leaderboard");

    print_clan(lb.top_clans());

    print_player(lb.most_kills(), "Most kills", "Kills");
    print_player(lb.most_roadkills(), "Most roadkills", "Roadkills");
    print_player(lb.longest_kills(), "Longest kill", "Meters");

    print_player(lb.most_xp(), "Most XP", "XP");
    print_player(lb.most_heals(), "Most heal", "HP");
    print_player(lb.most_revives(), "Most revives", "Revives");

    print_player(lb.most_objectives_complete(), "Most objectives", "Objectives");

    print_player(lb.most_vehicles_destroyed(), "Vehicles destroyed", "Vehicles");
    print_player(lb.most_vehicle_repairs(), "Vehicle repairs", "Repairs");
}

Trait Implementations

impl Clone for BBApi

fn clone(&self) -> BBApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BBApi

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

Formats the value using the given formatter.

impl Default for BBApi

fn default() -> Self

Creates a new BBApi with the default URL
Default URL is https://publicapi.battlebit.cloud/

impl PartialEq for BBApi

fn eq(&self, other: &BBApi) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BBApi