spice-client 0.2.0

A pure Rust SPICE client library with native and WebAssembly support
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

//! Error types for the SPICE client library.

use thiserror::Error;

/// Errors that can occur when using the SPICE client.
///
/// This enum represents all possible errors that can be returned by the SPICE client
/// library. It includes network errors, protocol errors, authentication failures, and
/// other SPICE-specific error conditions.
#[derive(Error, Debug)]
pub enum SpiceError {
    /// An I/O error occurred during network communication.
    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    /// A connection error occurred.
    ///
    /// This typically happens when the client cannot establish a connection
    /// to the SPICE server or when the connection is unexpectedly dropped.
    #[error("Connection error: {0}")]
    Connection(String),

    /// A protocol error occurred.
    ///
    /// This indicates that the server sent invalid or unexpected data that
    /// doesn't conform to the SPICE protocol specification.
    #[error("Protocol error: {0}")]
    Protocol(String),

    /// The server's SPICE protocol version is incompatible with this client.
    #[error("Version mismatch: expected {expected}, got {actual}")]
    VersionMismatch {
        /// The protocol version expected by the client.
        expected: u32,
        /// The protocol version reported by the server.
        actual: u32,
    },

    /// An error occurred in a specific SPICE channel.
    ///
    /// This can happen during channel initialization, message processing,
    /// or when a channel encounters an unexpected state.
    #[error("Channel error: {0}")]
    Channel(String),

    /// Authentication with the SPICE server failed.
    ///
    /// This occurs when the provided password or ticket is incorrect,
    /// or when the authentication method is not supported.
    #[error("Authentication failed")]
    AuthenticationFailed,

    /// The connection to the SPICE server was closed.
    ///
    /// This can happen normally during shutdown or unexpectedly if
    /// the server terminates the connection.
    #[error("Connection closed")]
    ConnectionClosed,

    /// Serialization/deserialization error from binrw.
    #[error("Serialization error: {0}")]
    Serialization(String),

    /// Binary read/write error from binrw.
    #[error("Binary I/O error: {0}")]
    BinRw(#[from] binrw::Error),
}

/// A type alias for `Result<T, SpiceError>`.
///
/// This is the standard result type used throughout the SPICE client library.
/// All fallible operations return this type.
pub type Result<T> = std::result::Result<T, SpiceError>;