chrony-confile 0.1.0

A full-featured Rust library for parsing, editing, validating, and serializing chrony configuration files
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
//! Builder pattern for programmatic configuration generation.
//!
//! Provides [`ServerBuilder`] and [`PoolBuilder`] for constructing `server` and `pool`
//! directives with type-safe method chaining. All options are validated at call time
//! via the bounded integer newtypes from [`values`](crate::values).

use crate::ast::*;
use crate::span::Span;
use crate::values::*;

/// Builder for creating `server` directives programmatically.
///
/// Provides a type-safe, chainable API for constructing [`DirectiveKind::Server`] values
/// with all supported options. Every option is validated at call time via the bounded
/// integer newtypes from [`crate::values`].
///
/// # Examples
///
/// ```rust
/// use chrony_confile::builder::ServerBuilder;
/// use chrony_confile::values::{PollInterval, UdpPort};
///
/// let directive = ServerBuilder::new("ntp.example.com")
///     .iburst()
///     .prefer()
///     .minpoll(PollInterval::new(4)?)
///     .maxpoll(PollInterval::new(10)?)
///     .build();
///
/// assert_eq!(directive.kind.name(), "server");
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
#[derive(Debug, Clone)]
pub struct ServerBuilder {
    pub(crate) config: ServerConfig,
}

impl ServerBuilder {
    /// Creates a new builder for the given hostname.
    ///
    /// All other options are initialized to chrony defaults.
    #[must_use]
    pub fn new(hostname: impl Into<String>) -> Self {
        Self {
            config: ServerConfig {
                hostname: hostname.into(),
                ..Default::default()
            },
        }
    }

    /// Enables the `iburst` option (initial burst of quick measurements).
    #[must_use]
    pub fn iburst(mut self) -> Self {
        self.config.iburst = true;
        self
    }

    /// Enables the `burst` option (always burst measurements).
    #[must_use]
    pub fn burst(mut self) -> Self {
        self.config.burst = true;
        self
    }

    /// Sets the `prefer` selection option.
    #[must_use]
    pub fn prefer(mut self) -> Self {
        self.config.select_opts.set(SelectOptions::PREFER);
        self
    }

    /// Sets the `noselect` selection option.
    #[must_use]
    pub fn noselect(mut self) -> Self {
        self.config.select_opts.set(SelectOptions::NOSELECT);
        self
    }

    /// Sets the `trust` selection option.
    #[must_use]
    pub fn trust(mut self) -> Self {
        self.config.select_opts.set(SelectOptions::TRUST);
        self
    }

    /// Sets the `require` selection option.
    #[must_use]
    pub fn require(mut self) -> Self {
        self.config.select_opts.set(SelectOptions::REQUIRE);
        self
    }

    /// Enables NTS (Network Time Security) for this source.
    #[must_use]
    pub fn nts(mut self) -> Self {
        self.config.nts = true;
        self
    }

    /// Marks the source as initially offline.
    #[must_use]
    pub fn offline(mut self) -> Self {
        self.config.connectivity = SourceConnectivity::Offline;
        self
    }

    /// Sets the minimum polling interval (as a power of 2 in seconds).
    #[must_use]
    pub fn minpoll(mut self, poll: PollInterval) -> Self {
        self.config.minpoll = poll;
        self
    }

    /// Sets the maximum polling interval (as a power of 2 in seconds).
    #[must_use]
    pub fn maxpoll(mut self, poll: PollInterval) -> Self {
        self.config.maxpoll = poll;
        self
    }

    /// Sets the UDP port for this source.
    #[must_use]
    pub fn port(mut self, port: UdpPort) -> Self {
        self.config.port = port;
        self
    }

    /// NTS port for the server.
    #[must_use]
    pub fn ntsport(mut self, port: UdpPort) -> Self {
        self.config.nts_port = port;
        self
    }

    /// Sets the maximum expected round-trip delay (seconds).
    #[must_use]
    pub fn maxdelay(mut self, delay: f64) -> Self {
        self.config.max_delay = delay;
        self
    }

    /// Max delay ratio.
    #[must_use]
    pub fn maxdelayratio(mut self, ratio: f64) -> Self {
        self.config.max_delay_ratio = ratio;
        self
    }

    /// Max delay dev ratio.
    #[must_use]
    pub fn maxdelaydevratio(mut self, ratio: f64) -> Self {
        self.config.max_delay_dev_ratio = ratio;
        self
    }

    /// Max delay quantile.
    #[must_use]
    pub fn maxdelayquant(mut self, quant: f64) -> Self {
        self.config.max_delay_quant = quant;
        self
    }

    /// Min delay.
    #[must_use]
    pub fn mindelay(mut self, delay: f64) -> Self {
        self.config.min_delay = delay;
        self
    }

    /// Asymmetry.
    #[must_use]
    pub fn asymmetry(mut self, asym: f64) -> Self {
        self.config.asymmetry = asym;
        self
    }

    /// Auto offline mode.
    #[must_use]
    pub fn auto_offline(mut self) -> Self {
        self.config.auto_offline = true;
        self
    }

    /// Interleaved mode (xleave).
    #[must_use]
    pub fn xleave(mut self) -> Self {
        self.config.interleaved = true;
        self
    }

    /// Copy peer measurement statistics.
    #[must_use]
    pub fn copy(mut self) -> Self {
        self.config.copy = true;
        self
    }

    /// Presend poll interval.
    #[must_use]
    pub fn presend(mut self, poll: PollInterval) -> Self {
        self.config.presend = poll;
        self
    }

    /// Filter value.
    #[must_use]
    pub fn filter(mut self, n: u32) -> Self {
        self.config.filter = Some(n);
        self
    }

    /// Address family.
    #[must_use]
    pub fn family(mut self, family: AddressFamily) -> Self {
        self.config.family = family;
        self
    }

    /// Extension field ID (hex).
    #[must_use]
    pub fn extfield(mut self, id: u32) -> Self {
        self.config.ext_fields = id;
        self
    }

    /// Sets the time offset for this source (seconds).
    #[must_use]
    pub fn offset(mut self, offset: f64) -> Self {
        self.config.offset = offset;
        self
    }

    /// Sets the NTP protocol version for this source.
    #[must_use]
    pub fn version(mut self, version: NtpVersion) -> Self {
        self.config.version = Some(version);
        self
    }

    /// Sets the authentication key ID for this source.
    #[must_use]
    pub fn key(mut self, key_id: u32) -> Self {
        self.config.authkey = key_id;
        self
    }

    /// Sets the authentication key ID (alias for `key`).
    #[must_use]
    pub fn authkey(mut self, key_id: u32) -> Self {
        self.config.authkey = key_id;
        self
    }

    /// Sets the minimum number of samples to keep.
    #[must_use]
    pub fn minsamples(mut self, n: u32) -> Self {
        self.config.min_samples = Some(n);
        self
    }

    /// Sets the maximum number of samples to keep.
    #[must_use]
    pub fn maxsamples(mut self, n: u32) -> Self {
        self.config.max_samples = Some(n);
        self
    }

    /// Sets the poll target number of samples.
    #[must_use]
    pub fn polltarget(mut self, target: PollTarget) -> Self {
        self.config.poll_target = target;
        self
    }

    /// Sets the minimum stratum for this source.
    #[must_use]
    pub fn minstratum(mut self, stratum: Stratum) -> Self {
        self.config.min_stratum = stratum;
        self
    }

    /// Sets the certificate set ID for NTS.
    #[must_use]
    pub fn certset(mut self, id: u32) -> Self {
        self.config.cert_set = id;
        self
    }

    /// Builds and returns a `server` directive with the configured options.
    #[must_use]
    pub fn build(self) -> Box<Directive> {
        Box::new(Directive::new(
            DirectiveKind::Server(self.config),
            Span::new(None, 0, 0, 0),
        ))
    }
}

/// Builder for creating `pool` directives.
#[derive(Debug, Clone)]
pub struct PoolBuilder {
    config: PoolConfig,
}

impl PoolBuilder {
    /// Creates a new builder for the given pool hostname.
    ///
    /// All other options are initialized to chrony defaults.
    #[must_use]
    pub fn new(hostname: impl Into<String>) -> Self {
        Self {
            config: PoolConfig {
                source: ServerConfig {
                    hostname: hostname.into(),
                    ..Default::default()
                },
                max_sources: 4,
            },
        }
    }

    /// Enables the `iburst` option (initial burst of quick measurements).
    #[must_use]
    pub fn iburst(mut self) -> Self {
        self.config.source.iburst = true;
        self
    }

    #[must_use]
    pub fn burst(mut self) -> Self {
        self.config.source.burst = true;
        self
    }

    #[must_use]
    pub fn prefer(mut self) -> Self {
        self.config.source.select_opts.set(SelectOptions::PREFER);
        self
    }

    #[must_use]
    pub fn noselect(mut self) -> Self {
        self.config.source.select_opts.set(SelectOptions::NOSELECT);
        self
    }

    #[must_use]
    pub fn trust(mut self) -> Self {
        self.config.source.select_opts.set(SelectOptions::TRUST);
        self
    }

    #[must_use]
    pub fn require(mut self) -> Self {
        self.config.source.select_opts.set(SelectOptions::REQUIRE);
        self
    }

    #[must_use]
    pub fn nts(mut self) -> Self {
        self.config.source.nts = true;
        self
    }

    #[must_use]
    pub fn offline(mut self) -> Self {
        self.config.source.connectivity = SourceConnectivity::Offline;
        self
    }

    #[must_use]
    pub fn minpoll(mut self, poll: PollInterval) -> Self {
        self.config.source.minpoll = poll;
        self
    }

    #[must_use]
    pub fn maxpoll(mut self, poll: PollInterval) -> Self {
        self.config.source.maxpoll = poll;
        self
    }

    #[must_use]
    pub fn port(mut self, port: UdpPort) -> Self {
        self.config.source.port = port;
        self
    }

    #[must_use]
    pub fn maxdelay(mut self, delay: f64) -> Self {
        self.config.source.max_delay = delay;
        self
    }

    #[must_use]
    pub fn offset(mut self, offset: f64) -> Self {
        self.config.source.offset = offset;
        self
    }

    #[must_use]
    pub fn version(mut self, version: NtpVersion) -> Self {
        self.config.source.version = Some(version);
        self
    }

    #[must_use]
    pub fn key(mut self, key_id: u32) -> Self {
        self.config.source.authkey = key_id;
        self
    }

    /// Sets the minimum number of samples to keep.
    #[must_use]
    pub fn minsamples(mut self, n: u32) -> Self {
        self.config.source.min_samples = Some(n);
        self
    }

    /// Sets the maximum number of samples to keep.
    #[must_use]
    pub fn maxsamples(mut self, n: u32) -> Self {
        self.config.source.max_samples = Some(n);
        self
    }

    /// Sets the poll target number of samples.
    #[must_use]
    pub fn polltarget(mut self, target: PollTarget) -> Self {
        self.config.source.poll_target = target;
        self
    }

    /// Sets the maximum number of sources from this pool.
    #[must_use]
    pub fn maxsources(mut self, n: u32) -> Self {
        self.config.max_sources = n;
        self
    }

    /// Builds and returns a `pool` directive with the configured options.
    #[must_use]
    pub fn build(self) -> Box<Directive> {
        Box::new(Directive::new(
            DirectiveKind::Pool(self.config),
            Span::new(None, 0, 0, 0),
        ))
    }
}