arora-websocket 1.0.0

The open local bridge for Arora: a WebSocket server implementing arora-bridge, for editors and apps on trusted local links.
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

//! RPC method metadata types for the WebSocket messages.

use arora_types::value::{Type, Value};
use serde::{Deserialize, Serialize};

/// Descriptor for an RPC method parameter.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MethodParam {
    /// Parameter name
    pub name: String,

    /// Parameter type
    pub param_type: Type,

    /// Whether this parameter is required
    #[serde(default)]
    pub required: bool,

    /// Default value if not provided
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_value: Option<Value>,

    /// Human-readable description
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Metadata describing an available RPC method.
///
/// Methods represent callable operations that can be invoked via the Invoke message.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MethodInfo {
    /// Method path/name (e.g., "audio/play", "animation/trigger", "reset")
    pub path: String,

    /// Method parameters
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub params: Vec<MethodParam>,

    /// Return type (None means void/unit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub return_type: Option<Type>,

    /// Human-readable description
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// Result type for method invocation.
#[derive(Debug, Clone)]
pub struct InvokeResult {
    pub success: bool,
    pub value: Option<Value>,
    pub message: Option<String>,
}

impl InvokeResult {
    /// Create a successful result with no return value.
    pub fn ok() -> Self {
        Self {
            success: true,
            value: None,
            message: None,
        }
    }

    /// Create a successful result with a return value.
    pub fn ok_with_value(value: Value) -> Self {
        Self {
            success: true,
            value: Some(value),
            message: None,
        }
    }

    /// Create an error result.
    pub fn err(message: impl Into<String>) -> Self {
        Self {
            success: false,
            value: None,
            message: Some(message.into()),
        }
    }
}