pub struct Friends<Manager> { /* private fields */ }
Expand description

Access to the steam friends interface

Implementations§

source§

impl<Manager> Friends<Manager>

source

pub fn name(&self) -> String

Returns the (display) name of the current user

source

pub fn get_friends(&self, flags: FriendFlags) -> Vec<Friend<Manager>>

source

pub fn get_coplay_friends(&self) -> Vec<Friend<Manager>>

Returns recently played with players list

source

pub fn get_friend(&self, friend: SteamId) -> Friend<Manager>

source

pub fn request_user_information(&self, user: SteamId, name_only: bool) -> bool

source

pub fn activate_game_overlay(&self, dialog: &str)

source

pub fn activate_game_overlay_to_web_page(&self, url: &str)

source

pub fn activate_game_overlay_to_store( &self, app_id: AppId, overlay_to_store_flag: OverlayToStoreFlag )

source

pub fn activate_game_overlay_to_user(&self, dialog: &str, user: SteamId)

source

pub fn activate_invite_dialog(&self, lobby: LobbyId)

Opens up an invite dialog for the given lobby

source

pub fn set_rich_presence(&self, key: &str, value: Option<&str>) -> bool

Set rich presence for the user. Unsets the rich presence if value is None or empty. See Steam API

source

pub fn clear_rich_presence(&self)

Clears all of the current user’s Rich Presence key/values.

source

pub fn get_user_restrictions(&self) -> UserRestriction

Checks if current user is chat restricted.

If they are restricted, then they can’t send or receive any text/voice chat messages, can’t see custom avatars. A chat restricted user can’t add friends or join any groups. Restricted users can still be online and send/receive game invites.

Auto Trait Implementations§

§

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

§

impl<Manager> !Send for Friends<Manager>

§

impl<Manager> !Sync for Friends<Manager>

§

impl<Manager> Unpin for Friends<Manager>

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

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

§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

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

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.
§

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.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more