Struct steamworks::Client

pub struct Client<Manager = ClientManager> { /* fields omitted */ }

The main entry point into the steam client.

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

Implementations

impl Client<ClientManager>

pub fn init() -> SResult<(Client<ClientManager>, SingleClient<ClientManager>)>

Attempts to initialize the steamworks api 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
) -> SResult<(Client<ClientManager>, SingleClient<ClientManager>)>

Attempts to initialize the steamworks api for a specified app ID 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<Manager> Client<Manager>

pub fn register_callback<C, F>(&self, f: F) -> CallbackHandle<Manager> 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.

pub fn utils(&self) -> Utils<Manager>

Returns an accessor to the steam utils interface

pub fn matchmaking(&self) -> Matchmaking<Manager>

Returns an accessor to the steam matchmaking interface

pub fn networking(&self) -> Networking<Manager>

Returns an accessor to the steam networking interface

pub fn apps(&self) -> Apps<Manager>

Returns an accessor to the steam apps interface

pub fn friends(&self) -> Friends<Manager>

Returns an accessor to the steam friends interface

pub fn user(&self) -> User<Manager>

Returns an accessor to the steam user interface

pub fn user_stats(&self) -> UserStats<Manager>

Returns an accessor to the steam user stats interface

pub fn remote_storage(&self) -> RemoteStorage<Manager>

Returns an accessor to the steam remote storage interface

pub fn ugc(&self) -> UGC<Manager>

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

pub fn networking_messages(&self) -> NetworkingMessages<Manager>

pub fn networking_sockets(&self) -> NetworkingSockets<Manager>

pub fn networking_utils(&self) -> NetworkingUtils<Manager>

Trait Implementations

impl<Manager> Clone for Client<Manager>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Manager: Send + Sync> Send for Client<Manager>

impl<Manager: Send + Sync> Sync for Client<Manager>