lxmf-sdk 0.7.0

High-level Rust SDK for LXMF clients and RPC-backed LXMF workflows.
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

use super::config::{
    EventSinkKind, OverflowPolicy, RedactionTransform, StoreForwardCapacityPolicy,
    StoreForwardEvictionPriority,
};
use serde::{Deserialize, Serialize};
use serde_json::Value as JsonValue;
use std::collections::BTreeMap;

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct EventStreamPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_poll_events: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_event_bytes: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_batch_bytes: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_extension_keys: Option<Option<usize>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct RedactionPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<Option<bool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sensitive_transform: Option<Option<RedactionTransform>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub break_glass_allowed: Option<Option<bool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub break_glass_ttl_ms: Option<Option<u64>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct TokenAuthPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issuer: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub audience: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub jti_cache_ttl_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub clock_skew_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shared_secret: Option<Option<String>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct MtlsAuthPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ca_bundle_path: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_client_cert: Option<Option<bool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_san: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_cert_path: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_key_path: Option<Option<String>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct RpcBackendPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub listen_addr: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_timeout_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub write_timeout_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_header_bytes: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_body_bytes: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub token_auth: Option<Option<TokenAuthPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mtls_auth: Option<Option<MtlsAuthPatch>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct StoreForwardPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_messages: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_message_age_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub capacity_policy: Option<Option<StoreForwardCapacityPolicy>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eviction_priority: Option<Option<StoreForwardEvictionPriority>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct EventSinkPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<Option<bool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_event_bytes: Option<Option<usize>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_kinds: Option<Option<Vec<EventSinkKind>>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<Option<BTreeMap<String, JsonValue>>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct ConfigPatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub overflow_policy: Option<Option<OverflowPolicy>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub block_timeout_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub store_forward: Option<Option<StoreForwardPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event_sink: Option<Option<EventSinkPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub event_stream: Option<Option<EventStreamPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub idempotency_ttl_ms: Option<Option<u64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redaction: Option<Option<RedactionPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rpc_backend: Option<Option<RpcBackendPatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<Option<BTreeMap<String, JsonValue>>>,
}

impl ConfigPatch {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_overflow_policy(mut self, policy: OverflowPolicy) -> Self {
        self.overflow_policy = Some(Some(policy));
        self
    }

    pub fn with_block_timeout_ms(mut self, timeout_ms: u64) -> Self {
        self.block_timeout_ms = Some(Some(timeout_ms));
        self
    }

    pub fn with_store_forward_patch(mut self, patch: StoreForwardPatch) -> Self {
        self.store_forward = Some(Some(patch));
        self
    }

    pub fn with_event_sink_patch(mut self, patch: EventSinkPatch) -> Self {
        self.event_sink = Some(Some(patch));
        self
    }

    pub fn with_idempotency_ttl_ms(mut self, ttl_ms: u64) -> Self {
        self.idempotency_ttl_ms = Some(Some(ttl_ms));
        self
    }

    pub fn with_extension(mut self, key: impl Into<String>, value: JsonValue) -> Self {
        let mut extensions = self.extensions.unwrap_or(Some(BTreeMap::new())).unwrap_or_default();
        extensions.insert(key.into(), value);
        self.extensions = Some(Some(extensions));
        self
    }

    pub fn is_empty(&self) -> bool {
        self.overflow_policy.is_none()
            && self.block_timeout_ms.is_none()
            && self.store_forward.is_none()
            && self.event_sink.is_none()
            && self.event_stream.is_none()
            && self.idempotency_ttl_ms.is_none()
            && self.redaction.is_none()
            && self.rpc_backend.is_none()
            && self.extensions.is_none()
    }
}