rustifi 1.0.0

Open source Rust library to interface with Ubiquiti's UniFi Controller 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
94
95
96
97
98
99
100
101
102
103
104

use serde::Deserialize;

#[derive(Debug, Deserialize)]
pub struct ApiResponse<T> {
    pub data: T,
    #[serde(default)]
    pub meta: Option<ResponseMeta>,
    #[serde(default)]
    pub errors: Option<Vec<ApiError>>,
}

#[derive(Debug, Deserialize)]
pub struct ResponseMeta {
    pub rc: String,
}

#[derive(Debug, Deserialize)]
pub struct ApiError {
    pub code: String,
    pub message: String,
}

#[derive(Debug, Deserialize)]
pub struct PaginatedResponse<T> {
    pub data: Vec<T>,
    pub meta: PaginationMeta,
}

#[derive(Debug, Deserialize)]
pub struct PaginationMeta {
    pub total_count: usize,
    pub first: usize,
    pub last: usize,
}

/// Response format for site-scoped endpoints in the new API.
/// Pagination fields are at the top level (not nested in meta).
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SiteResponse<T> {
    pub data: Vec<T>,
    #[serde(default)]
    pub offset: usize,
    #[serde(default)]
    pub limit: usize,
    #[serde(default)]
    pub count: usize,
    #[serde(default)]
    pub total_count: usize,
}

impl<T> SiteResponse<T> {
    /// Check if there are more pages available.
    pub fn has_more(&self) -> bool {
        self.offset + self.count < self.total_count
    }

    /// Get the offset for the next page.
    /// Returns `None` if there are no more pages or no valid offset can be computed.
    pub fn next_offset(&self) -> Option<usize> {
        if !self.has_more() {
            return None;
        }
        if self.limit > 0 {
            Some(self.offset + self.limit)
        } else if self.count > 0 {
            Some(self.offset + self.count)
        } else {
            None
        }
    }
}

pub type ListResponse<T> = ApiResponse<Vec<T>>;
pub type SingleResponse<T> = ApiResponse<T>;

/// Response for create/update operations that return the created/updated entity.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct MutationResponse<T> {
    pub data: T,
}

/// Response for delete operations.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeleteResponse {
    #[serde(default)]
    pub http_status_code: Option<u16>,
}

/// Empty response for operations that don't return data.
#[derive(Debug, Clone, Deserialize)]
pub struct EmptyResponse {}

/// Response for action operations that return a status.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ActionResponse {
    #[serde(default)]
    pub success: bool,
    #[serde(default)]
    pub message: Option<String>,
}