rust-sc2 1.1.2

Rust implementation of StarCraft II API
Documentation 
1
2
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! Contains nice wrapper around SC2 API.

use crate::{
	bot::{Locked, Rl},
	client::{SC2Result, WS},
};
use protobuf::Message;
use sc2_proto::sc2api::{Request, Response};
use tungstenite::Message::Binary;

/// SC2 API. Can be accessed through [`self.api()`](crate::bot::Bot::api).
pub struct API(Rl<WS>);
impl API {
	pub(crate) fn new(ws: WS) -> API {
		API(Rl::new(ws))
	}

	/// Sends request and returns a response.
	pub fn send(&self, req: Request) -> SC2Result<Response> {
		let mut ws = self.0.write_lock();

		ws.write_message(Binary(req.write_to_bytes()?))?;

		let msg = ws.read_message()?;

		let mut res = Response::new();
		res.merge_from_bytes(msg.into_data().as_slice())?;
		Ok(res)
	}

	/// Sends request, waits for the response, but ignores it (useful when response is empty).
	pub fn send_request(&self, req: Request) -> SC2Result<()> {
		let mut ws = self.0.write_lock();
		ws.write_message(Binary(req.write_to_bytes()?))?;
		let _ = ws.read_message()?;
		Ok(())
	}

	/// Sends request, but doesn't wait for the response (use only when more control required,
	/// in common cases prefered to use [`send`] or [`send_request`]).
	///
	/// [`send`]: Self::send
	/// [`send_request`]: Self::send_request
	pub fn send_only(&self, req: Request) -> SC2Result<()> {
		self.0.write_lock().write_message(Binary(req.write_to_bytes()?))?;
		Ok(())
	}
	/// Waits for a response (useful only after [`send_only`]).
	///
	/// [`send_only`]: Self::send_only
	pub fn wait_response(&self) -> SC2Result<Response> {
		let msg = self.0.write_lock().read_message()?;

		let mut res = Response::new();
		res.merge_from_bytes(msg.into_data().as_slice())?;
		Ok(res)
	}
}