Struct Server

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

Represents a game server running a Steam game.

let server = Server::new("127.0.0.1:12345").expect("Connect to dedicated server running Valve game");

let info = server.info().expect("Get general server information");
let players = server.players().expect("Get server player information");
let rules = server.rules().expect("Get server rules");

Implementations§

Source§

impl Server

Source

pub fn new(url: &str) -> Result<Self, Box<dyn Error>>

Examples found in repository?
examples/basic.rs (line 5)
3fn main() {
4    let server =
5        Server::new("127.0.0.1:12345").expect("Connect to dedicated server running Valve game");
6
7    let info = server.info().expect("Get general server information");
8    let players = server.players().expect("Get server player information");
9    let rules = server.rules().expect("Get server rules");
10
11    // Server Information
12    let server_name = info.name();
13    let loaded_map = info.map();
14    let max_players = info.player_max();
15    let players_online = info.player_count();
16
17    println!("Server Name:     {}", &server_name);
18    println!("Map Loaded:      {}", &loaded_map);
19    println!("Players Max:     {}", &max_players);
20    println!("Players Online:  {}", &players_online);
21
22    println!("");
23
24    // Player Information
25    for player in players.iter() {
26        println!("Player: {:?}", player);
27    }
28
29    println!("");
30
31    // Rules
32    for (rule, setting) in rules.iter() {
33        println!("Rule:    {}", rule);
34        println!("Setting: {}", setting);
35    }
36}
Source§

impl Server

Socket Settings

Source

pub fn set_read_timeout( &mut self, duration: Option<Duration>, ) -> Result<(), Box<dyn Error>>

Source

pub fn set_write_timeout( &mut self, duration: Option<Duration>, ) -> Result<(), Box<dyn Error>>

Source§

impl Server

Source

pub fn info(&self) -> Result<Info, Error>

Examples found in repository?
examples/basic.rs (line 7)
3fn main() {
4    let server =
5        Server::new("127.0.0.1:12345").expect("Connect to dedicated server running Valve game");
6
7    let info = server.info().expect("Get general server information");
8    let players = server.players().expect("Get server player information");
9    let rules = server.rules().expect("Get server rules");
10
11    // Server Information
12    let server_name = info.name();
13    let loaded_map = info.map();
14    let max_players = info.player_max();
15    let players_online = info.player_count();
16
17    println!("Server Name:     {}", &server_name);
18    println!("Map Loaded:      {}", &loaded_map);
19    println!("Players Max:     {}", &max_players);
20    println!("Players Online:  {}", &players_online);
21
22    println!("");
23
24    // Player Information
25    for player in players.iter() {
26        println!("Player: {:?}", player);
27    }
28
29    println!("");
30
31    // Rules
32    for (rule, setting) in rules.iter() {
33        println!("Rule:    {}", rule);
34        println!("Setting: {}", setting);
35    }
36}
Source§

impl Server

Source

pub fn players(&self) -> Result<Vec<Player>, Error>

Examples found in repository?
examples/basic.rs (line 8)
3fn main() {
4    let server =
5        Server::new("127.0.0.1:12345").expect("Connect to dedicated server running Valve game");
6
7    let info = server.info().expect("Get general server information");
8    let players = server.players().expect("Get server player information");
9    let rules = server.rules().expect("Get server rules");
10
11    // Server Information
12    let server_name = info.name();
13    let loaded_map = info.map();
14    let max_players = info.player_max();
15    let players_online = info.player_count();
16
17    println!("Server Name:     {}", &server_name);
18    println!("Map Loaded:      {}", &loaded_map);
19    println!("Players Max:     {}", &max_players);
20    println!("Players Online:  {}", &players_online);
21
22    println!("");
23
24    // Player Information
25    for player in players.iter() {
26        println!("Player: {:?}", player);
27    }
28
29    println!("");
30
31    // Rules
32    for (rule, setting) in rules.iter() {
33        println!("Rule:    {}", rule);
34        println!("Setting: {}", setting);
35    }
36}
Source§

impl Server

A2S_RULES Implementation

Source

pub fn rules(&self) -> Result<Rules, Error>

Examples found in repository?
examples/basic.rs (line 9)
3fn main() {
4    let server =
5        Server::new("127.0.0.1:12345").expect("Connect to dedicated server running Valve game");
6
7    let info = server.info().expect("Get general server information");
8    let players = server.players().expect("Get server player information");
9    let rules = server.rules().expect("Get server rules");
10
11    // Server Information
12    let server_name = info.name();
13    let loaded_map = info.map();
14    let max_players = info.player_max();
15    let players_online = info.player_count();
16
17    println!("Server Name:     {}", &server_name);
18    println!("Map Loaded:      {}", &loaded_map);
19    println!("Players Max:     {}", &max_players);
20    println!("Players Online:  {}", &players_online);
21
22    println!("");
23
24    // Player Information
25    for player in players.iter() {
26        println!("Player: {:?}", player);
27    }
28
29    println!("");
30
31    // Rules
32    for (rule, setting) in rules.iter() {
33        println!("Rule:    {}", rule);
34        println!("Setting: {}", setting);
35    }
36}
Source

pub fn get_rules(bytes: &[u8]) -> Rules

Trait Implementations§

Source§

impl Debug for Server

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Server

§

impl RefUnwindSafe for Server

§

impl Send for Server

§

impl Sync for Server

§

impl Unpin for Server

§

impl UnwindSafe for Server

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