veltrix 0.6.0

Unix helpers, service integrations, and Unicode metadata
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

use std::collections::BTreeMap;

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

/// Common Technitium HTTP API envelope.
#[derive(Debug, Clone, Deserialize)]
#[serde(bound(deserialize = "T: Deserialize<'de>"))]
pub struct TechnitiumApiEnvelope<T> {
    #[serde(default)]
    pub status: Option<String>,

    #[serde(default)]
    pub response: Option<T>,

    #[serde(rename = "errorMessage", alias = "error_message", default)]
    pub error_message: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Login/session response shape.
#[derive(Debug, Clone, Deserialize)]
pub struct TechnitiumSession {
    #[serde(
        rename = "token",
        alias = "sessionToken",
        alias = "session_token",
        default
    )]
    pub token: Option<String>,

    #[serde(default)]
    pub user: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Server status payload.
#[derive(Debug, Clone, Deserialize)]
pub struct TechnitiumServerStatus {
    #[serde(default)]
    pub version: Option<String>,

    #[serde(default)]
    pub uptime: Option<Value>,

    #[serde(default)]
    pub dns_server_domain: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// DNS zone summary.
#[derive(Debug, Clone, Deserialize)]
pub struct TechnitiumZoneSummary {
    #[serde(rename = "name", alias = "zone", alias = "domain", default)]
    pub name: Option<String>,

    #[serde(rename = "type", alias = "zoneType", alias = "zone_type", default)]
    pub zone_type: Option<String>,

    #[serde(default)]
    pub disabled: Option<bool>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Explicit DNS record kinds targeted by the services contract.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum TechnitiumRecordType {
    A,
    AAAA,
    CNAME,
    MX,
    TXT,
    NS,
    SRV,
    CAA,
    PTR,
}

impl TechnitiumRecordType {
    /// Return the DNS record type name used by Technitium API parameters.
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::A => "A",
            Self::AAAA => "AAAA",
            Self::CNAME => "CNAME",
            Self::MX => "MX",
            Self::TXT => "TXT",
            Self::NS => "NS",
            Self::SRV => "SRV",
            Self::CAA => "CAA",
            Self::PTR => "PTR",
        }
    }
}

impl std::fmt::Display for TechnitiumRecordType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

/// Basic DNS record payload shared by read-only preview workflows.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TechnitiumDnsRecord {
    pub name: String,

    #[serde(rename = "type")]
    pub record_type: TechnitiumRecordType,

    #[serde(default)]
    pub ttl: Option<u32>,

    #[serde(default)]
    pub value: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}