Enum SteamError 

#[non_exhaustive]
pub enum SteamError {
    Io(Error),
    Connection(String),
    ConnectionClosed,
    Timeout(Duration),
    JobFailed,
    Cancelled,
    Authentication(String),
    Protocol(String),
    Malformed(String),
    Decompression(String),
    Crypto(String),
    InvalidArgument(String),
    NotFound(String),
    Json(Error),
    Protobuf(DecodeError),
    ProtobufEncode(EncodeError),
    Other(String),
}

The error type used throughout the crate.

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.

Io(Error)

A socket, file or pipe level failure.

Connection(String)

The connection to the Steam network could not be established, or was lost.

ConnectionClosed

The remote end closed the connection.

Timeout(Duration)

The operation did not complete within its deadline.

JobFailed

The server rejected the job (EMsg::DestJobFailed).

Cancelled

The operation was cancelled by the caller.

Authentication(String)

Authentication failed.

Protocol(String)

The peer sent data that does not match the protocol.

Malformed(String)

A message could not be decoded.

Decompression(String)

A compressed payload could not be decompressed.

Crypto(String)

A cryptographic operation failed.

InvalidArgument(String)

A caller supplied an argument the callee cannot work with.

NotFound(String)

The requested resource does not exist.

Json(Error)

JSON (de)serialisation failed.

Protobuf(DecodeError)

A protobuf payload could not be decoded.

ProtobufEncode(EncodeError)

A protobuf payload could not be encoded.

Other(String)

Anything that does not fit a more specific variant.

Implementations

impl SteamError

pub fn connection(message: impl Display) -> Self

Builds a SteamError::Connection from anything displayable.

pub fn protocol(message: impl Display) -> Self

Builds a SteamError::Protocol from anything displayable.

pub fn invalid_argument(message: impl Display) -> Self

Builds a SteamError::InvalidArgument from anything displayable.

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<AsyncJobFailedException> for SteamError

fn from(_: AsyncJobFailedException) -> Self

Converts to this type from the input type.

impl From<AuthenticationException> for SteamError

fn from(value: AuthenticationException) -> Self

Converts into SteamError.

impl From<DecodeError> for SteamError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<EncodeError> for SteamError

fn from(source: EncodeError) -> 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<InvalidParamException> for SteamError

fn from(value: InvalidParamException) -> Self

Converts to this type from the input type.

impl From<SteamKitWebRequestException> for SteamError

fn from(value: SteamKitWebRequestException) -> Self

Converts to this type from the input type.

impl From<UnknownEnumValue> for SteamError

fn from(value: UnknownEnumValue) -> Self

Converts to this type from the input type.

impl From<WebAPIRequestException> for SteamError

fn from(value: WebAPIRequestException) -> Self

Converts into SteamError.