Struct bevy_steamworks::Client[−][src]

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>[src]

pub fn init(
) -> Result<(Client<ClientManager>, SingleClient<ClientManager>), SteamError>[src]

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

  • 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>[src]

pub fn register_callback<C, F>(&self, f: F) -> CallbackHandle<Manager> where
    C: Callback,
    F: FnMut(C) + 'static + Send, [src]

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>[src]

Returns an accessor to the steam utils interface

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

Returns an accessor to the steam matchmaking interface

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

Returns an accessor to the steam networking interface

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

Returns an accessor to the steam apps interface

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

Returns an accessor to the steam friends interface

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

Returns an accessor to the steam user interface

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

Returns an accessor to the steam user stats interface

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

Returns an accessor to the steam remote storage interface

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

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

Trait Implementations

impl<Manager> Clone for Client<Manager>[src]

pub fn clone(&self) -> Client<Manager>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<Manager> Send for Client<Manager> where
    Manager: Send + Sync, [src]

impl<Manager> Sync for Client<Manager> where
    Manager: Send + Sync, [src]

Auto Trait Implementations

impl<Manager> RefUnwindSafe for Client<Manager> where
    Manager: RefUnwindSafe, 

impl<Manager> Unpin for Client<Manager>

impl<Manager> UnwindSafe for Client<Manager> where
    Manager: RefUnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any, 

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync, 

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<T> TypeData for T where
    T: 'static + Send + Sync + Clone, 

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V

impl<T> Component for T where
    T: 'static + Send + Sync, [src]