veltrix 0.7.3

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

use std::time::Duration;

/// Supported Technitium DNS Server HTTP API family.
pub const SUPPORTED_TECHNITIUM_API_VERSION: &str = "13.x HTTP API";

/// Authentication material for Technitium DNS Server API requests.
///
/// Tokens are intentionally not included in `Debug` output. Callers should
/// avoid logging complete specs because base URLs can still reveal topology.
#[derive(Clone)]
pub enum TechnitiumAuth {
    /// No credentials are configured.
    None,
    /// Session token returned by login/session workflows.
    SessionToken { token: String },
    /// Caller-provided bearer token.
    BearerToken { token: String },
}

impl std::fmt::Debug for TechnitiumAuth {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::None => f.write_str("None"),
            Self::SessionToken { .. } => f.write_str("SessionToken { token: <redacted> }"),
            Self::BearerToken { .. } => f.write_str("BearerToken { token: <redacted> }"),
        }
    }
}

impl TechnitiumAuth {
    /// Create session-token authentication.
    pub fn session_token(token: impl Into<String>) -> Self {
        Self::SessionToken {
            token: token.into(),
        }
    }

    /// Create bearer-token authentication.
    pub fn bearer_token(token: impl Into<String>) -> Self {
        Self::BearerToken {
            token: token.into(),
        }
    }

    /// Return whether this auth value contains credentials.
    pub fn is_authenticated(&self) -> bool {
        !matches!(self, Self::None)
    }
}

/// Technitium HTTP API client configuration.
#[derive(Debug, Clone)]
pub struct TechnitiumHttpSpec {
    /// Base HTTP URL for the Technitium server.
    pub base_url: String,
    /// Authentication mode and token material.
    pub auth: TechnitiumAuth,
    /// Optional request timeout.
    pub timeout: Option<Duration>,
}

impl TechnitiumHttpSpec {
    /// Create a new HTTP spec without credentials.
    pub fn new(base_url: impl Into<String>) -> Self {
        Self {
            base_url: base_url.into(),
            auth: TechnitiumAuth::None,
            timeout: None,
        }
    }

    /// Set the authentication mode.
    pub fn auth(mut self, auth: TechnitiumAuth) -> Self {
        self.auth = auth;
        self
    }

    /// Set the request timeout.
    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }
}

/// Metadata describing which Technitium backend produced a response.
#[derive(Debug, Clone)]
pub enum TechnitiumBackendUsed {
    /// HTTP API backend metadata.
    Http { base_url: String },
}

/// Response wrapper for Technitium operations with data.
#[derive(Debug, Clone)]
pub struct TechnitiumResponse<T> {
    /// Backend metadata for this response.
    pub backend: TechnitiumBackendUsed,
    /// Response payload.
    pub data: T,
}

impl<T> TechnitiumResponse<T> {
    /// Create a Technitium response wrapper.
    pub fn new(data: T, backend: TechnitiumBackendUsed) -> Self {
        Self { backend, data }
    }
}

/// Response wrapper for successful Technitium operations with no body.
#[derive(Debug, Clone)]
pub struct TechnitiumEmptyResponse {
    /// Backend metadata for this response.
    pub backend: TechnitiumBackendUsed,
}

impl TechnitiumEmptyResponse {
    /// Create an empty Technitium response wrapper.
    pub fn new(backend: TechnitiumBackendUsed) -> Self {
        Self { backend }
    }
}