Struct Client 

pub struct Client { /* private fields */ }

The main entry point into the steam client.

This provides access to all of the steamworks api that clients can use.

Implementations

impl Client

pub fn init() -> SIResult<Client>

Attempts to initialize the steamworks api without full API integration through SteamAPI_InitFlat added in SDK 1.59 and returns a client to access the rest of the api.

This should only ever have one instance per a program.

Errors

This can fail if:

• The steam client isn’t running

• The app ID of the game couldn’t be determined.

  If the game isn’t being run through steam this can be provided by placing a steam_appid.txt with the ID inside in the current working directory. Alternatively, you can use Client::init_app(<app_id>) to force a specific app ID.

• The game isn’t running on the same user/level as the steam client

• The user doesn’t own a license for the game.

• The app ID isn’t completely set up.

pub fn init_app<ID: Into<AppId>>(app_id: ID) -> SIResult<Client>

Attempts to initialize the steamworks api with the APP_ID without full API integration through SteamAPI_InitFlat and returns a client to access the rest of the api.

This should only ever have one instance per a program.

Errors

This can fail if:

• The steam client isn’t running
• The game isn’t running on the same user/level as the steam client
• The user doesn’t own a license for the game.
• The app ID isn’t completely set up.

impl Client

pub fn run_callbacks(&self)

Runs any currently pending callbacks

This runs all currently pending callbacks on the current thread.

This should be called frequently (e.g. once per a frame) in order to reduce the latency between recieving events.

pub fn process_callbacks(&self, callback_handler: impl FnMut(CallbackResult))

Runs any currently pending callbacks.

This is identical to run_callbacks in every way, except that callback_handler is called for every callback invoked.

This option provides an alternative for handling callbacks that can doesn’t require the handler to be Send, and 'static.

This should be called frequently (e.g. once per a frame) in order to reduce the latency between recieving events.

pub fn register_callback<C, F>(&self, f: F) -> CallbackHandle

where C: Callback, F: FnMut(C) + 'static + Send,

Registers the passed function as a callback for the given type.

The callback will be run on the thread that run_callbacks is called when the event arrives.

If the callback handler cannot be made Send or 'static the call to run_callbacks should be replaced with a call to process_callbacks instead.

pub fn utils(&self) -> Utils

Returns an accessor to the steam utils interface

pub fn matchmaking(&self) -> Matchmaking

Returns an accessor to the steam matchmaking interface

pub fn matchmaking_servers(&self) -> MatchmakingServers

Returns an accessor to the steam matchmaking_servers interface

pub fn networking(&self) -> Networking

Returns an accessor to the steam networking interface

pub fn apps(&self) -> Apps

Returns an accessor to the steam apps interface

pub fn friends(&self) -> Friends

Returns an accessor to the steam friends interface

pub fn input(&self) -> Input

Returns an accessor to the steam input interface

pub fn user(&self) -> User

Returns an accessor to the steam user interface

pub fn user_stats(&self) -> UserStats

Returns an accessor to the steam user stats interface

pub fn remote_play(&self) -> RemotePlay

Returns an accessor to the steam remote play interface

pub fn remote_storage(&self) -> RemoteStorage

Returns an accessor to the steam remote storage interface

pub fn screenshots(&self) -> Screenshots

Returns an accessor to the steam screenshots interface

pub fn ugc(&self) -> UGC

Returns an accessor to the steam UGC interface (steam workshop)

pub fn timeline(&self) -> Timeline

Returns an accessor to the steam timeline interface

pub fn networking_messages(&self) -> NetworkingMessages

pub fn networking_sockets(&self) -> NetworkingSockets

pub fn networking_utils(&self) -> NetworkingUtils

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.