Struct ServerData

Source
pub struct ServerData { /* private fields */ }
Expand description

Data of a single server

Implementations§

Source§

impl ServerData

Auto-generated by derive_getters::Getters.

Source

pub fn name(&self) -> &String

The name of this server.

Examples found in repository?
examples/serverlist.rs (line 10)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 19)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn map(&self) -> &String

The map name that the server runs.

Examples found in repository?
examples/serverlist.rs (line 12)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 21)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn map_size(&self) -> &MapSize

The size of the map.

Examples found in repository?
examples/serverlist.rs (line 13)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 22)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn gamemode(&self) -> &Gamemode

The current gamemode on this server.

Examples found in repository?
examples/serverlist.rs (line 11)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 20)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn region(&self) -> &Region

The region where this server is in.

Source

pub fn player_count(&self) -> &u8

The amount of players currently playing on this server.

Source

pub fn queued_player_count(&self) -> &u16

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

Source

pub fn max_players(&self) -> &u8

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

Source

pub fn hz(&self) -> &u8

The refreshrate/tickrate of this server.

Examples found in repository?
examples/serverlist.rs (line 14)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 23)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn day_night(&self) -> &DayNight

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

Source

pub fn is_official(&self) -> &bool

Whether or not this server is official.

Source

pub fn has_password(&self) -> &bool

Whether or not this server has a password.

Source

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)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 24)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source

pub fn build(&self) -> &String

The build that this server runs.

Examples found in repository?
examples/serverlist.rs (line 16)
3fn main() {
4    let api = BBApi::new();
5    let server_list = api.server_list()
6        .expect("Retrieving server list");
7
8    server_list.into_iter().for_each(|server| {
9        println!("{} [{}, {}, {}] ({}, {}, {})", 
10            server.name(), 
11            server.gamemode(), 
12            server.map(),
13            server.map_size(),
14            server.hz(), 
15            server.anti_cheat(),
16            server.build()
17        )
18    });
19}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 25)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}
Source§

impl ServerData

Source

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)
3fn main() {
4    let api = BBApi::new();
5
6    let server_list = api.server_list()
7        .expect("Retrieving server list");
8
9    let servers_with_unknown: Vec<battlebit_api::ServerData> = server_list
10        .into_iter()
11        .filter(|server| server.has_unknown())
12        .collect();
13
14    if servers_with_unknown.is_empty() {
15        println!("No servers with unknown fields found!")
16    } else {
17        servers_with_unknown.iter().for_each(|server| {
18            println!("{} [{}, {}, {}] ({}, {}, {})", 
19                server.name(), 
20                server.gamemode(), 
21                server.map(),
22                server.map_size(),
23                server.hz(), 
24                server.anti_cheat(),
25                server.build()
26            )
27        });
28    }
29}

Trait Implementations§

Source§

impl Clone for ServerData

Source§

fn clone(&self) -> ServerData

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerData

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ServerData

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ServerData

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ServerData

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T