Struct 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

The name of this server.

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

examples/serverlist_unknown.rs (line 19)

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 map(&self) -> &String

The map name that the server runs.

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

examples/serverlist_unknown.rs (line 21)

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 map_size(&self) -> &MapSize

The size of the map.

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

examples/serverlist_unknown.rs (line 22)

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 gamemode(&self) -> &Gamemode

The current gamemode on this server.

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

examples/serverlist_unknown.rs (line 20)

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 region(&self) -> &Region

The region where this server is in.

pub fn player_count(&self) -> &u8

The amount of players currently playing on this server.

pub fn queued_player_count(&self) -> &u16

The amount of players currently in queue to join this server.

pub fn max_players(&self) -> &u8

The maximum amount of players that can be on this server.

pub fn hz(&self) -> &u8

The refreshrate/tickrate of this server.

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

examples/serverlist_unknown.rs (line 23)

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 day_night(&self) -> &DayNight

Time of day on the map, see DayNight for more info.

pub fn is_official(&self) -> &bool

Whether or not this server is official.

pub fn has_password(&self) -> &bool

Whether or not this server has a password.

pub fn anti_cheat(&self) -> &AntiCheat

The type of anticheat used on this server. See AntiCHeat for more info.

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

examples/serverlist_unknown.rs (line 24)

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 build(&self) -> &String

The build that this server runs.

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

examples/serverlist_unknown.rs (line 25)

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

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.

Examples found in repository

examples/serverlist_unknown.rs (line 11)

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

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

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 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