surreal-client 0.4.0

CBOR-based SurrealDB client for the Vantage data framework
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

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// RPC message structure for SurrealDB communication
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RpcMessage {
    pub id: u64,
    pub method: String,
    pub params: Vec<Value>,
}

impl RpcMessage {
    /// Create a new RPC message with the given method
    pub fn new(method: impl Into<String>) -> Self {
        Self {
            id: 0,
            method: method.into(),
            params: Vec::new(),
        }
    }

    /// Set the ID for this message
    pub fn with_id(mut self, id: u64) -> Self {
        self.id = id;
        self
    }

    /// Set the parameters for this message
    pub fn with_params(mut self, params: Vec<Value>) -> Self {
        self.params = params;
        self
    }

    /// Add a single parameter to this message
    pub fn with_param(mut self, param: Value) -> Self {
        self.params.push(param);
        self
    }

    /// Convert to JSON string for HTTP transport
    pub fn to_json(&self) -> serde_json::Result<String> {
        serde_json::to_string(self)
    }

    /// Create from JSON string
    pub fn from_json(json: &str) -> serde_json::Result<Self> {
        serde_json::from_str(json)
    }
}

/// RPC response structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RpcResponse {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<u64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub result: Option<Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<RpcError>,
}

/// RPC error structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RpcError {
    pub code: i32,
    pub message: String,
}

impl RpcResponse {
    /// Create from JSON string
    pub fn from_json(json: &str) -> serde_json::Result<Self> {
        serde_json::from_str(json)
    }

    /// Check if this response contains an error
    pub fn is_error(&self) -> bool {
        self.error.is_some()
    }

    /// Get the result or return an error
    pub fn into_result(self) -> Result<Value, crate::error::SurrealError> {
        match self.error {
            Some(err) => Err(crate::error::SurrealError::Rpc(err.message)),
            None => Ok(self.result.unwrap_or(Value::Null)),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_rpc_message_creation() {
        let msg = RpcMessage::new("ping")
            .with_id(1)
            .with_param(Value::String("test".to_string()));

        assert_eq!(msg.id, 1);
        assert_eq!(msg.method, "ping");
        assert_eq!(msg.params.len(), 1);
    }

    #[test]
    fn test_rpc_message_serialization() {
        let msg = RpcMessage::new("query").with_id(42).with_params(vec![
            Value::String("SELECT * FROM user".to_string()),
            Value::Object(serde_json::Map::new()),
        ]);

        let json = msg.to_json().unwrap();
        let deserialized = RpcMessage::from_json(&json).unwrap();

        assert_eq!(msg.id, deserialized.id);
        assert_eq!(msg.method, deserialized.method);
        assert_eq!(msg.params.len(), deserialized.params.len());
    }
}