Enum SteamError 

#[non_exhaustive]
pub enum SteamError {
    SteamResult(EResult),
    ConnectionError(String),
    AlreadyLoggedOn,
    AlreadyConnecting,
    NotLoggedOn,
    NotConnected,
    InvalidCredentials,
    SteamGuardRequired {
        guard_type: EAuthSessionGuardType,
        email_domain: Option<String>,
    },
    TwoFactorRequired,
    InvalidToken(String),
    NetworkError(Error),
    Timeout,
    ResponseTimeout,
    DeserializationFailed,
    ProtocolError(String),
    BadResponse {
        message: String,
        emsg: Option<EMsg>,
        raw_bytes: Option<Vec<u8>>,
    },
    SessionError(SessionError),
    NotImplemented(String),
    Reqwest(Error),
    WebSocket(Error),
    Decode(DecodeError),
    Other(String),
}

Errors that can occur when using the Steam client.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SteamResult(EResult)

Steam returned an error result.

ConnectionError(String)

Connection error.

AlreadyLoggedOn

Already logged on.

AlreadyConnecting

Already connecting.

NotLoggedOn

Not logged on.

NotConnected

Not connected.

InvalidCredentials

Invalid credentials.

SteamGuardRequired

Steam Guard authentication required.

This error is returned when password authentication requires a Steam Guard code. The guard_type indicates what kind of code is needed:

• EmailCode: A code sent to the account’s email
• DeviceCode: A TOTP code from the Steam mobile app
• DeviceConfirmation: Approval via the Steam mobile app

Fields

guard_type: EAuthSessionGuardType

Type of Steam Guard verification needed.

email_domain: Option<String>

Email domain hint (e.g., “g****.com”) if guard_type is EmailCode.

TwoFactorRequired

Two-factor authentication required (legacy).

InvalidToken(String)

Invalid token.

NetworkError(Error)

Network error.

Timeout

Timeout.

ResponseTimeout

Response timed out.

DeserializationFailed

Deserialization failed.

ProtocolError(String)

Protocol error.

BadResponse

Bad response from Steam.

This error is returned when Steam returns a malformed response or one that violates expectations (e.g. missing SteamID in logon response).

Fields

message: String

Human-readable error message.

emsg: Option<EMsg>

The EMsg that triggered this error (if known).

raw_bytes: Option<Vec<u8>>

The raw bytes that failed to parse (truncated for display).

SessionError(SessionError)

Session error.

NotImplemented(String)

Not implemented yet.

Reqwest(Error)

HTTP/Reqwest error (transparent — preserves source() chain).

WebSocket(Error)

WebSocket transport error (transparent — preserves source() chain).

Decode(DecodeError)

Protobuf decode error (transparent — preserves source() chain).

Other(String)

Other error.

Implementations

impl SteamError

pub fn eresult(&self) -> Option<EResult>

Returns the EResult if this is a Steam result error.

pub fn is_retryable(&self) -> bool

Returns true if the error is a transient error that might be resolved by retrying.

Matches Node.js behavior for handling:

• Fail
• ServiceUnavailable
• TryAnotherCM
• NoConnection (in logoff context)

pub fn bad_response(message: impl Into<String>) -> Self

Create a BadResponse error with just a message (backwards-compatible shorthand).

pub fn bad_response_with_context( message: impl Into<String>, emsg: Option<EMsg>, raw_bytes: Option<Vec<u8>>, ) -> Self

Create a BadResponse error with full context.

Trait Implementations

impl Debug for SteamError

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

Formats the value using the given formatter.

impl Display for SteamError

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

Formats the value using the given formatter.

impl Error for SteamError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<CmError> for SteamError

fn from(e: CmError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for SteamError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for SteamError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SteamError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SteamError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SessionError> for SteamError

fn from(source: SessionError) -> Self

Converts to this type from the input type.