Enum SteamUserError 

pub enum SteamUserError {
    NotLoggedIn,
    SessionExpired,
    FamilyViewRestricted,
    LimitedAccount(String),
    HttpError(Error),
    MalformedResponse(String),
    SteamError(String),
    EResult {
        code: i32,
        message: String,
    },
    InvalidConfirmationKey,
    ConfirmationNotFound(u64),
    TwoFactorError(String),
    InvalidImageFormat(String),
    RateLimited,
    MissingCredential {
        field: &'static str,
    },
    HttpStatus {
        status: u16,
        url: String,
    },
    ClientBuild(String),
    RedirectError(String),
    InvalidInput(String),
    ProtobufEncode(EncodeError),
    ProtobufDecode(DecodeError),
    UrlError(ParseError),
    JsonError(Error),
    Base64Error(DecodeError),
    Io(Error),
    SystemTime(SystemTimeError),
    Other(String),
    Totp(TotpError),
    Middleware(Error),
    ActionFailed {
        action: ApiAction,
        source: Box<SteamUserError>,
    },
}

Errors that can occur during Steam Community operations.

Variants

NotLoggedIn

Not logged in to Steam Community.

SessionExpired

Session has expired and needs to be refreshed.

FamilyViewRestricted

Family View is restricting access.

LimitedAccount(String)

Account is limited (e.g. no games) and cannot access Web API.

HttpError(Error)

HTTP request failed.

MalformedResponse(String)

Invalid response from Steam.

SteamError(String)

Steam returned an error.

EResult

Steam returned an EResult error code.

Fields

code: i32

The error code.

message: String

Human-readable message.

InvalidConfirmationKey

Invalid confirmation key.

ConfirmationNotFound(u64)

Confirmation not found.

TwoFactorError(String)

Invalid 2FA setup state.

InvalidImageFormat(String)

Invalid image format.

RateLimited

Rate limited by Steam.

MissingCredential

A required credential (token/secret) is missing.

Fields

field: &'static str

The name of the missing field (e.g. “access_token”, “refresh_token”).

HttpStatus

HTTP request returned a non-success status code.

Fields

status: u16

The HTTP status code.

url: String

The URL that returned the error.

ClientBuild(String)

Failed to build the HTTP client.

RedirectError(String)

Redirect handling error (loop, missing Location header, too many hops).

InvalidInput(String)

Invalid or malformed input parameter.

ProtobufEncode(EncodeError)

Protobuf encoding error.

ProtobufDecode(DecodeError)

Protobuf decoding error.

UrlError(ParseError)

URL parsing error.

JsonError(Error)

JSON parsing error.

Base64Error(DecodeError)

Base64 decoding error.

Io(Error)

I/O error (filesystem, OS-level).

SystemTime(SystemTimeError)

SystemTime error (clock went backwards before UNIX epoch).

Other(String)

Other error.

Totp(TotpError)

TOTP generation error.

Middleware(Error)

Middleware error from reqwest-middleware. Note: We use anyhow::Error here because reqwest-middleware::Error::Middleware wraps anyhow::Error, and we want to preserve the full error chain.

ActionFailed

An error that occurred while performing a specific API action.

Fields

action: ApiAction

The action that failed

source: Box<SteamUserError>

The underlying error

Implementations

impl SteamUserError

pub fn api_action(&self) -> Option<ApiAction>

Check if this error was wrapped with an API action context.

pub fn from_eresult(code: i32) -> Self

Create an EResult error from a code.

pub fn check_eresult(code: i32) -> Result<(), Self>

Check if eresult code is OK (1).

pub fn is_retryable(&self) -> bool

Returns true if the error is likely transient and safe to retry.

Trait Implementations

impl Debug for SteamUserError

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

Formats the value using the given formatter.

impl Display for SteamUserError

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

Formats the value using the given formatter.

impl Error for SteamUserError

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<DecodeError> for SteamUserError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for SteamUserError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<EncodeError> for SteamUserError

fn from(source: EncodeError) -> Self

Converts to this type from the input type.

impl From<Error> for SteamUserError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SteamUserError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SteamUserError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SteamUserError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for SteamUserError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<SystemTimeError> for SteamUserError

fn from(source: SystemTimeError) -> Self

Converts to this type from the input type.

impl From<TotpError> for SteamUserError

fn from(source: TotpError) -> Self

Converts to this type from the input type.