Struct battlebit_api::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

Get field name from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 10)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 19)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn map(&self) -> &String

Get field map from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 12)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 21)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn map_size(&self) -> &MapSize

Get field map_size from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 13)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 22)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn gamemode(&self) -> &Gamemode

Get field gamemode from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 11)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 20)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn region(&self) -> &Region

Get field region from instance of ServerData.

source

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.

source

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.

source

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.

source

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)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 23)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn day_night(&self) -> &DayNight

Get field day_night from instance of ServerData.

source

pub fn is_official(&self) -> &bool

Get field is_official from instance of ServerData.

source

pub fn has_password(&self) -> &bool

Get field has_password from instance of ServerData.

source

pub fn anti_cheat(&self) -> &AntiCheat

Get field anti_cheat from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 15)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 24)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

pub fn build(&self) -> &String

Get field build from instance of ServerData.

Examples found in repository?
examples/serverlist.rs (line 16)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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()
        )
    });
}
More examples
Hide additional examples
examples/serverlist_unknown.rs (line 25)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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()
            )
        });
    }
}
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)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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§

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

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

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

§

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

§

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

§

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