Struct SteamID 

pub struct SteamID {
    pub universe: Universe,
    pub account_type: AccountType,
    pub instance: u32,
    pub account_id: u32,
}

Represents a Steam ID with all its components.

Fields

universe: Universe

The Steam universe this ID belongs to.

account_type: AccountType

The type of account this ID represents.

instance: u32

The instance of the account.

account_id: u32

The unique account identifier.

Implementations

impl SteamID

pub fn new() -> SteamID

Creates a new invalid SteamID.

pub fn from_individual_account_id(account_id: u32) -> SteamID

Creates a SteamID from an individual account ID.

This is a convenience method for creating a typical user SteamID in the public universe with a desktop instance.

pub fn from_steam_id64(id: u64) -> SteamID

Parse a SteamID from a 64-bit integer.

pub fn is_valid(&self) -> bool

Returns whether Steam would consider this ID to be “valid”.

This does not check whether the given ID belongs to a real account, nor does it check that the given ID is for an individual account or in the public universe.

pub fn is_valid_individual(&self) -> bool

Returns whether this SteamID is valid and belongs to an individual user in the public universe with a desktop instance.

This is what most people think of when they think of a SteamID. Does not check whether the account actually exists.

pub fn is_group_chat(&self) -> bool

Checks whether this ID is for a legacy group chat.

pub fn is_lobby(&self) -> bool

Checks whether this ID is for a game lobby.

pub fn steam2(&self, newer_format: bool) -> Result<String, SteamIdError>

Renders the ID in Steam2 format (e.g. “STEAM_0:0:23071901”).

Arguments

• newer_format - If true, use 1 as the first digit instead of 0 for the public universe.

Errors

Returns an error if this is not an individual account type.

pub fn steam3(&self) -> String

Renders the ID in Steam3 format (e.g. “[U:1:46143802]”).

pub fn steam_id64(&self) -> u64

Renders the ID in 64-bit decimal format.

Trait Implementations

impl Clone for SteamID

fn clone(&self) -> SteamID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SteamID

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

Formats the value using the given formatter.

impl Default for SteamID

fn default() -> SteamID

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SteamID

fn deserialize<D>( deserializer: D, ) -> Result<SteamID, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SteamID

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

Formats the value using the given formatter.

impl From<u64> for SteamID

fn from(value: u64) -> SteamID

Converts to this type from the input type.

impl FromStr for SteamID

type Err = SteamIdError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<SteamID, <SteamID as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SteamID

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SteamID

fn eq(&self, other: &SteamID) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SteamID

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for SteamID

type Error = SteamIdError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<SteamID, <SteamID as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for SteamID

type Error = SteamIdError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<SteamID, <SteamID as TryFrom<String>>::Error>

Performs the conversion.

impl Copy for SteamID

impl Eq for SteamID

impl StructuralPartialEq for SteamID