steamkit-rs 0.1.2

Rust port of SteamKit2, a .NET library that aims to interoperate with the Steam network.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! The crate-wide error type.

use std::fmt;

/// Shorthand for `Result<T, SteamError>`.
pub type SteamResult<T> = Result<T, SteamError>;

/// The error type used throughout the crate.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum SteamError {
    /// A socket, file or pipe level failure.
    #[error("i/o error: {0}")]
    Io(#[from] std::io::Error),

    /// The connection to the Steam network could not be established, or was lost.
    #[error("connection error: {0}")]
    Connection(String),

    /// The remote end closed the connection.
    #[error("connection closed by peer")]
    ConnectionClosed,

    /// The operation did not complete within its deadline.
    #[error("timed out after {0:?}")]
    Timeout(std::time::Duration),

    /// The server rejected the job (`EMsg::DestJobFailed`).
    #[error("job failed: the request was rejected by the server")]
    JobFailed,

    /// The operation was cancelled by the caller.
    #[error("operation was cancelled")]
    Cancelled,

    /// Authentication failed.
    #[error("authentication failed: {0}")]
    Authentication(String),

    /// The peer sent data that does not match the protocol.
    #[error("protocol error: {0}")]
    Protocol(String),

    /// A message could not be decoded.
    #[error("malformed message: {0}")]
    Malformed(String),

    /// A compressed payload could not be decompressed.
    #[error("decompression failed: {0}")]
    Decompression(String),

    /// A cryptographic operation failed.
    #[error("cryptographic error: {0}")]
    Crypto(String),

    /// A caller supplied an argument the callee cannot work with.
    #[error("invalid argument: {0}")]
    InvalidArgument(String),

    /// The requested resource does not exist.
    #[error("not found: {0}")]
    NotFound(String),

    /// JSON (de)serialisation failed.
    #[error("json error: {0}")]
    Json(#[from] serde_json::Error),

    /// A protobuf payload could not be decoded.
    #[error("protobuf decode error: {0}")]
    Protobuf(#[from] prost::DecodeError),

    /// A protobuf payload could not be encoded.
    #[error("protobuf encode error: {0}")]
    ProtobufEncode(#[from] prost::EncodeError),

    /// Anything that does not fit a more specific variant.
    #[error("{0}")]
    Other(String),
}

impl SteamError {
    /// Builds a [`SteamError::Connection`] from anything displayable.
    pub fn connection(message: impl fmt::Display) -> Self {
        SteamError::Connection(message.to_string())
    }

    /// Builds a [`SteamError::Protocol`] from anything displayable.
    pub fn protocol(message: impl fmt::Display) -> Self {
        SteamError::Protocol(message.to_string())
    }

    /// Builds a [`SteamError::InvalidArgument`] from anything displayable.
    pub fn invalid_argument(message: impl fmt::Display) -> Self {
        SteamError::InvalidArgument(message.to_string())
    }
}