veltrix 0.3.0

General utilities
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

use std::path::PathBuf;

/// Supported Caddy major version for this integration.
pub const SUPPORTED_CADDY_MAJOR: u64 = 2;

/// Caddy Admin API endpoint transport.
#[derive(Debug, Clone)]
pub enum CaddyAdminEndpoint {
    /// HTTP endpoint, usually `http://localhost:2019`.
    Http { base_url: String },
    /// Unix-domain socket endpoint.
    UnixSocket { socket_path: PathBuf },
}

impl Default for CaddyAdminEndpoint {
    fn default() -> Self {
        Self::Http {
            base_url: "http://localhost:2019".to_string(),
        }
    }
}

/// Caddy Admin API client configuration.
#[derive(Debug, Clone, Default)]
pub struct CaddyAdminSpec {
    /// Configured admin endpoint.
    pub endpoint: CaddyAdminEndpoint,
}

impl CaddyAdminSpec {
    /// Create a spec for an explicit endpoint.
    pub fn new(endpoint: CaddyAdminEndpoint) -> Self {
        Self { endpoint }
    }

    /// Use Caddy's default local HTTP admin endpoint.
    pub fn localhost_default() -> Self {
        Self::default()
    }

    /// Use an HTTP admin endpoint.
    pub fn http(base_url: impl Into<String>) -> Self {
        Self {
            endpoint: CaddyAdminEndpoint::Http {
                base_url: base_url.into(),
            },
        }
    }

    /// Use a Unix-domain socket admin endpoint.
    pub fn unix_socket(socket_path: impl Into<PathBuf>) -> Self {
        Self {
            endpoint: CaddyAdminEndpoint::UnixSocket {
                socket_path: socket_path.into(),
            },
        }
    }
}

/// Metadata describing the Caddy backend used for a response.
#[derive(Debug, Clone)]
pub enum CaddyBackendUsed {
    /// HTTP Admin API backend.
    Http { base_url: String },
    /// Unix-domain socket Admin API backend.
    UnixSocket { socket_path: PathBuf },
}

/// Response wrapper for Caddy Admin API calls with a JSON body.
#[derive(Debug, Clone)]
pub struct CaddyResponse<T> {
    /// Backend metadata for this response.
    pub backend: CaddyBackendUsed,
    /// Deserialized response payload.
    pub data: T,
}

/// Response wrapper for successful Caddy calls with no response body.
#[derive(Debug, Clone)]
pub struct CaddyEmptyResponse {
    /// Backend metadata for this response.
    pub backend: CaddyBackendUsed,
}