Struct AsyncInterface 

pub struct AsyncInterface { /* private fields */ }

One interface of the Web API.

Implementations

impl AsyncInterface

pub fn new( http_client: Client, base_address: Url, iface: impl Into<String>, api_key: impl Into<String>, ) -> Self

Creates an interface for the given Web API interface.

pub fn iface(&self) -> &str

The name of the Web API interface, for example ISteamDirectory.

pub fn api_key(&self) -> &str

The API key used for authorized requests.

pub fn base_address(&self) -> &Url

The base address of the Web API.

pub fn timeout(&self) -> Duration

The timeout for Web API requests.

pub fn set_timeout(&self, timeout: Duration)

Sets the timeout for Web API requests.

pub async fn call( &self, func: &str, version: i32, args: &[WebApiArgument], ) -> Result<KeyValue, SteamError>

Calls a Web API function. The response is requested as VDF and parsed into a KeyValue.

pub async fn call_with_method( &self, method: Method, func: &str, version: i32, args: &[WebApiArgument], ) -> Result<KeyValue, SteamError>

Calls a Web API function with the given HTTP method. The response is requested as VDF and parsed into a KeyValue.

pub async fn call_protobuf<T>( &self, method: Method, func: &str, version: i32, args: &[WebApiArgument], ) -> Result<T, SteamError>

where T: Message + Default,

Calls a Web API function and parses the protobuf response.

pub async fn call_protobuf_with_request<TResponse, TRequest>( &self, method: Method, func: &str, request: &TRequest, version: i32, extra_args: &[WebApiArgument], ) -> Result<WebAPIResponse<TResponse>, SteamError>

where TResponse: Message + Default, TRequest: Message + Default,

Calls a Web API function with a protobuf request and parses the protobuf response. The request goes base64-encoded in input_protobuf_encoded; the result code comes from the x-eresult response header.