Struct steamworks::Client

pub struct Client(_);

The core type of this crate, representing an initialized Steamworks API.

It’s a handle that can be cheaply cloned.

Implementations

impl Client

pub fn init(steam_app_id: Option<u32>) -> Result<Self, InitError>

Initializes the Steamworks API, yielding a Client.

A Steam App ID can be provided, which functions as an alternative to using a steam_appid.txt file.

Returns an error if there is already an initialized Client, or if SteamAPI_Init() fails for some other reason.

pub fn find_leaderboard( &self, leaderboard_name: impl Into<Vec<u8>> ) -> BoxFuture<'_, Result<LeaderboardHandle, FindLeaderboardError>>

https://partner.steamgames.com/doc/api/ISteamUserStats#FindLeaderboard

Returns an error if the leaderboard name contains nul bytes, is longer than 128 bytes, or if the leaderboard is not found.

pub fn query_all_ugc(&self, matching_ugc_type: MatchingUgcType) -> QueryAllUgc

Returns ugc::QueryAllUgc, which follows the builder pattern, allowing you to configure a UGC query before running it.

pub fn app_id(&self) -> AppId

https://partner.steamgames.com/doc/api/ISteamUtils#GetAppID

pub fn steam_id(&self) -> SteamId

https://partner.steamgames.com/doc/api/ISteamUser#GetSteamID

pub fn on_persona_state_changed( &self ) -> impl Stream<Item = PersonaStateChange> + Send

https://partner.steamgames.com/doc/api/ISteamFriends#PersonaStateChange_t

pub fn on_steam_shutdown(&self) -> impl Stream<Item = ()> + Send

https://partner.steamgames.com/doc/api/ISteamUtils#SteamShutdown_t

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.