xui-rs 1.0.2

A modern, typed async Rust SDK for the 3x-ui panel API
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

use std::fmt;

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

/// Runtime `OpenAPI` document embedded in the connected panel.
///
/// The model stays open-ended so extensions and schemas from future panel
/// versions are preserved exactly.
#[derive(Clone, Deserialize, PartialEq, Serialize)]
#[serde(transparent)]
pub struct OpenApiDocument(Value);

impl OpenApiDocument {
    /// Borrows the complete `OpenAPI` JSON document.
    pub const fn as_value(&self) -> &Value {
        &self.0
    }

    /// Consumes the wrapper and returns the complete JSON document.
    pub fn into_value(self) -> Value {
        self.0
    }

    /// Returns the declared `OpenAPI` version string.
    pub fn version(&self) -> Option<&str> {
        self.0.get("openapi").and_then(Value::as_str)
    }

    /// Counts real HTTP operations, excluding documentation-only WebSocket
    /// message pseudo-operations.
    pub fn http_operation_count(&self) -> usize {
        const METHODS: &[&str] = &[
            "get", "head", "post", "put", "patch", "delete", "options", "trace",
        ];
        self.0
            .get("paths")
            .and_then(Value::as_object)
            .into_iter()
            .flat_map(|paths| paths.values())
            .filter_map(Value::as_object)
            .map(|item| {
                METHODS
                    .iter()
                    .filter(|method| item.contains_key(**method))
                    .count()
            })
            .sum()
    }
}

impl From<Value> for OpenApiDocument {
    fn from(value: Value) -> Self {
        Self(value)
    }
}

impl fmt::Debug for OpenApiDocument {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("OpenApiDocument")
            .field("version", &self.version())
            .field("http_operation_count", &self.http_operation_count())
            .finish_non_exhaustive()
    }
}

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

    #[test]
    fn openapi_document_counts_only_http_operations() {
        let value = json!({
            "openapi": "3.0.3",
            "paths": {
                "/one": {"get": {}, "post": {}, "parameters": []},
                "/two": {"delete": {}, "websocket": {}}
            }
        });
        let document = OpenApiDocument::from(value.clone());
        assert_eq!(document.version(), Some("3.0.3"));
        assert_eq!(document.http_operation_count(), 3);
        assert!(format!("{document:?}").contains("http_operation_count: 3"));
        assert_eq!(document.as_value(), &value);
        assert_eq!(document.into_value(), value);

        let empty = OpenApiDocument::from(json!({}));
        assert_eq!(empty.version(), None);
        assert_eq!(empty.http_operation_count(), 0);
    }
}