Struct battlebit_api::ServerData

pub struct ServerData { /* private fields */ }

Data of a single server

Implementations

impl ServerData

Auto-generated by derive_getters::Getters.

pub fn name(&self) -> &String

Get field name from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 10)

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()
        )
    });
}

pub fn map(&self) -> &String

Get field map from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 12)

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()
        )
    });
}

pub fn map_size(&self) -> &MapSize

Get field map_size from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 13)

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()
        )
    });
}

pub fn gamemode(&self) -> &Gamemode

Get field gamemode from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 11)

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()
        )
    });
}

pub fn region(&self) -> &Region

Get field region from instance of ServerData.

pub fn player_count(&self) -> &u8

Get field player_count from instance of ServerData.
SAFETY: Unless Battlebit upgrades their engine, this number should fit into a u8.

pub fn queued_player_count(&self) -> &u16

Get field queued_player_count from instance of ServerData.
SAFETY: The queued player count should realistically never reach 65_535.

pub fn max_players(&self) -> &u8

Get field max_players from instance of ServerData.
SAFETY: Unless Battlebit upgrades their engine, this number should fit into a u8.

pub fn hz(&self) -> &u8

Get field hz from instance of ServerData.
SAFETY: Unless Battlebit upgrades their engine, this number should fit into a u8.

Examples found in repository

examples/serverlist.rs (line 14)

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()
        )
    });
}

pub fn day_night(&self) -> &DayNight

Get field day_night from instance of ServerData.

pub fn is_official(&self) -> &bool

Get field is_official from instance of ServerData.

pub fn has_password(&self) -> &bool

Get field has_password from instance of ServerData.

pub fn anti_cheat(&self) -> &AntiCheat

Get field anti_cheat from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 15)

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()
        )
    });
}

pub fn build(&self) -> &String

Get field build from instance of ServerData.

Examples found in repository

examples/serverlist.rs (line 16)

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()
        )
    });
}

impl ServerData

pub fn has_unknown(&self) -> bool

Small check if this ServerData has Unknown fields.
Mostly used by me to check if this API client is outdated.

Trait Implementations

impl Clone for ServerData

fn clone(&self) -> ServerData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerData

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ServerData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerData