clasp-core 4.3.0

Core types and encoding for CLASP protocol
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Error types for Clasp

use thiserror::Error;

/// Result type alias for Clasp operations
pub type Result<T> = std::result::Result<T, Error>;

/// Clasp error types
#[derive(Error, Debug)]
pub enum Error {
    /// Invalid magic byte in frame header
    #[error("invalid magic byte: expected 0x53, got 0x{0:02x}")]
    InvalidMagic(u8),

    /// Frame payload too large
    #[error("payload too large: {0} bytes (max 65535)")]
    PayloadTooLarge(usize),

    /// Frame buffer too small
    #[error("buffer too small: need {needed} bytes, have {have}")]
    BufferTooSmall { needed: usize, have: usize },

    /// MessagePack encoding error
    #[error("encode error: {0}")]
    EncodeError(String),

    /// MessagePack decoding error
    #[error("decode error: {0}")]
    DecodeError(String),

    /// Invalid message type code
    #[error("unknown message type: 0x{0:02x}")]
    UnknownMessageType(u8),

    /// Invalid signal type
    #[error("unknown signal type: {0}")]
    UnknownSignalType(String),

    /// Invalid address format
    #[error("invalid address: {0}")]
    InvalidAddress(String),

    /// Address pattern compilation error
    #[error("invalid pattern: {0}")]
    InvalidPattern(String),

    /// State conflict
    #[error("state conflict: revision {expected} expected, got {actual}")]
    RevisionConflict { expected: u64, actual: u64 },

    /// Lock held by another session
    #[error("lock held by {holder}")]
    LockHeld { holder: String },

    /// Permission denied
    #[error("permission denied: {0}")]
    PermissionDenied(String),

    /// Connection error
    #[error("connection error: {0}")]
    ConnectionError(String),

    /// Timeout
    #[error("operation timed out")]
    Timeout,

    /// Generic protocol error
    #[error("protocol error: {0}")]
    Protocol(String),
}

impl From<rmp_serde::encode::Error> for Error {
    fn from(e: rmp_serde::encode::Error) -> Self {
        Error::EncodeError(e.to_string())
    }
}

impl From<rmp_serde::decode::Error> for Error {
    fn from(e: rmp_serde::decode::Error) -> Self {
        Error::DecodeError(e.to_string())
    }
}

/// Protocol error codes (for ERROR messages)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u16)]
pub enum ErrorCode {
    // 100-199: Protocol errors
    InvalidFrame = 100,
    InvalidMessage = 101,
    UnsupportedVersion = 102,

    // 200-299: Address errors
    InvalidAddress = 200,
    AddressNotFound = 201,
    PatternError = 202,

    // 300-399: Permission errors
    Unauthorized = 300,
    Forbidden = 301,
    TokenExpired = 302,

    // 400-499: State errors
    RevisionConflict = 400,
    LockHeld = 401,
    InvalidValue = 402,

    // 500-599: Server errors
    InternalError = 500,
    ServiceUnavailable = 501,
    Timeout = 502,
}

impl ErrorCode {
    pub fn from_u16(code: u16) -> Option<Self> {
        match code {
            100 => Some(ErrorCode::InvalidFrame),
            101 => Some(ErrorCode::InvalidMessage),
            102 => Some(ErrorCode::UnsupportedVersion),
            200 => Some(ErrorCode::InvalidAddress),
            201 => Some(ErrorCode::AddressNotFound),
            202 => Some(ErrorCode::PatternError),
            300 => Some(ErrorCode::Unauthorized),
            301 => Some(ErrorCode::Forbidden),
            302 => Some(ErrorCode::TokenExpired),
            400 => Some(ErrorCode::RevisionConflict),
            401 => Some(ErrorCode::LockHeld),
            402 => Some(ErrorCode::InvalidValue),
            500 => Some(ErrorCode::InternalError),
            501 => Some(ErrorCode::ServiceUnavailable),
            502 => Some(ErrorCode::Timeout),
            _ => None,
        }
    }
}