env-reader 0.1.0

Read configuration from environment variables: blank is absent, every problem is reported at once, and a secret never prints.
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
//! Reading a whole configuration, collecting every problem on the way.

use std::collections::BTreeMap;
use std::str::FromStr;

use crate::error::{Error, Errors};
use crate::secret::Secret;
use crate::value::{parse_bool, parse_bool_lenient, parse_csv, present};

/// What an unparseable integer is reported as.
const A_WHOLE_NUMBER: &str = "a whole number";

/// Reads a configuration from variables, accumulating problems rather than
/// stopping at the first.
///
/// A reader is built once, asked for every value the program needs, and
/// then [`finish`](Reader::finish)ed. Each getter returns a usable value
/// even when it failed — a required string that was missing comes back
/// empty — so a caller can read the whole configuration in one straight run
/// of statements without `?` after every line. `finish` is what decides
/// whether any of it was valid.
///
/// That shape is the point: a program with four missing variables reports
/// all four, once, instead of over four restarts.
///
/// # Examples
///
/// ```
/// use env_reader::Reader;
///
/// #[derive(Debug)]
/// struct Config {
///     service_name: String,
///     port: u16,
///     upstreams: Vec<String>,
/// }
///
/// let mut reader = Reader::from_pairs([
///     ("SERVICE_NAME", "orders"),
///     ("PORT", "8443"),
///     ("UPSTREAMS", "a.internal, b.internal"),
/// ]);
///
/// let config = Config {
///     service_name: reader.required_string("SERVICE_NAME"),
///     port: reader.integer_or("PORT", 8080),
///     upstreams: reader.list("UPSTREAMS"),
/// };
/// reader.finish()?;
///
/// assert_eq!(config.port, 8443);
/// assert_eq!(config.upstreams, ["a.internal", "b.internal"]);
/// # Ok::<(), env_reader::Errors>(())
/// ```
#[derive(Debug, Clone)]
pub struct Reader {
    /// The variables this reader sees.
    source: BTreeMap<String, String>,
    /// Problems found so far, in the order they were found.
    errors: Vec<Error>,
}

impl Reader {
    /// A reader over the process environment.
    ///
    /// The only constructor that touches the environment, so every other
    /// path is testable without mutating global state — which
    /// [`std::env::set_var`] is `unsafe` for good reason.
    #[must_use]
    pub fn from_env() -> Self {
        Self::from_pairs(std::env::vars())
    }

    /// A reader over an explicit set of variables, for tests and for
    /// configuration that arrives from somewhere other than the
    /// environment.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("PORT", "9000")]);
    /// assert_eq!(reader.integer_or::<u16>("PORT", 8080), 9000);
    /// ```
    pub fn from_pairs<K, V, I>(pairs: I) -> Self
    where
        I: IntoIterator<Item = (K, V)>,
        K: Into<String>,
        V: Into<String>,
    {
        Self {
            source: pairs
                .into_iter()
                .map(|(key, value)| (key.into(), value.into()))
                .collect(),
            errors: Vec::new(),
        }
    }

    // -- reading ----------------------------------------------------------

    /// The raw value of a variable, trimmed, or `None` when absent or
    /// blank.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("A", " x "), ("B", "  ")]);
    /// assert_eq!(reader.raw("A"), Some("x"));
    /// assert_eq!(reader.raw("B"), None);
    /// assert_eq!(reader.raw("C"), None);
    /// ```
    #[must_use]
    pub fn raw(&self, name: &str) -> Option<&str> {
        present(self.source.get(name).map(String::as_str))
    }

    /// Whether a variable is set to something non-blank.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("A", "x"), ("B", " ")]);
    /// assert!(reader.is_set("A"));
    /// assert!(!reader.is_set("B"), "blank is absent");
    /// assert!(!reader.is_set("C"));
    /// ```
    #[must_use]
    pub fn is_set(&self, name: &str) -> bool {
        self.raw(name).is_some()
    }

    /// A variable that must be set.
    ///
    /// Records [`Error::Missing`] and returns an empty string when it is
    /// not, so reading can continue and every other problem is found too.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("SERVICE_NAME", "orders")]);
    /// assert_eq!(reader.required_string("SERVICE_NAME"), "orders");
    /// assert_eq!(reader.required_string("REGION"), "");
    /// assert_eq!(reader.finish().unwrap_err().len(), 1);
    /// ```
    pub fn required_string(&mut self, name: &str) -> String {
        if let Some(value) = self.raw(name) {
            value.to_string()
        } else {
            self.errors.push(Error::missing(name));
            String::new()
        }
    }

    /// A variable that need not be set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("REGION", "eu-west-2")]);
    /// assert_eq!(reader.optional_string("REGION").as_deref(), Some("eu-west-2"));
    /// assert_eq!(reader.optional_string("ZONE"), None);
    /// ```
    #[must_use]
    pub fn optional_string(&self, name: &str) -> Option<String> {
        self.raw(name).map(str::to_string)
    }

    /// An optional variable with a fallback.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("HOST", "0.0.0.0")]);
    /// assert_eq!(reader.string_or("HOST", "127.0.0.1"), "0.0.0.0");
    /// assert_eq!(reader.string_or("BIND", "127.0.0.1"), "127.0.0.1");
    /// ```
    #[must_use]
    pub fn string_or(&self, name: &str, default: &str) -> String {
        self.raw(name).unwrap_or(default).to_string()
    }

    // -- secrets ----------------------------------------------------------

    /// A secret that must be set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("DB_PASSWORD", "hunter2")]);
    /// let password = reader.required_secret("DB_PASSWORD");
    /// assert_eq!(format!("{password:?}"), "<redacted>");
    /// ```
    pub fn required_secret(&mut self, name: &str) -> Secret {
        Secret::new(self.required_string(name))
    }

    /// A secret that need not be set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("API_KEY", "  ")]);
    /// assert!(reader.optional_secret("API_KEY").is_none());
    /// ```
    #[must_use]
    pub fn optional_secret(&self, name: &str) -> Option<Secret> {
        self.raw(name).map(Secret::new)
    }

    // -- integers ---------------------------------------------------------

    /// An integer that must be set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("PORT", "8443")]);
    /// assert_eq!(reader.required_integer::<u16>("PORT"), 8443);
    /// ```
    pub fn required_integer<T>(&mut self, name: &str) -> T
    where
        T: FromStr + Default,
    {
        self.required_parse(name, A_WHOLE_NUMBER).unwrap_or_default()
    }

    /// An integer that need not be set.
    ///
    /// A blank value is absent, not a parse failure.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("A", "30"), ("B", "  ")]);
    /// assert_eq!(reader.optional_integer::<u64>("A"), Some(30));
    /// assert_eq!(reader.optional_integer::<u64>("B"), None);
    /// assert!(reader.finish().is_ok());
    /// ```
    pub fn optional_integer<T>(&mut self, name: &str) -> Option<T>
    where
        T: FromStr,
    {
        self.optional_parse(name, A_WHOLE_NUMBER)
    }

    /// An integer with a fallback.
    ///
    /// An unparseable value is a recorded error, **not** a silent fallback
    /// to the default: a program quietly running on a default nobody chose
    /// is harder to diagnose than one that will not start.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("PORT", "8443"), ("OTHER", "two")]);
    /// assert_eq!(reader.integer_or::<u16>("PORT", 8080), 8443);
    /// assert_eq!(reader.integer_or::<u16>("MISSING", 8080), 8080);
    /// assert_eq!(reader.integer_or::<u16>("OTHER", 8080), 8080);
    /// // The absent one is fine; the unparseable one is not.
    /// assert_eq!(reader.finish().unwrap_err().len(), 1);
    /// ```
    pub fn integer_or<T>(&mut self, name: &str, default: T) -> T
    where
        T: FromStr,
    {
        self.parse_or(name, A_WHOLE_NUMBER, default)
    }

    /// An optional integer that, when present, must be greater than zero.
    ///
    /// For the "absent means unlimited" shape, where a configured zero is a
    /// mistake rather than a request for an infinite wait.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("A", "30"), ("B", "0")]);
    /// assert_eq!(reader.optional_positive_integer::<u32>("A"), Some(30));
    /// assert_eq!(reader.optional_positive_integer::<u32>("B"), None);
    /// assert_eq!(reader.optional_positive_integer::<u32>("C"), None);
    /// // Only B is a problem; C was simply absent.
    /// assert_eq!(reader.finish().unwrap_err().len(), 1);
    /// ```
    pub fn optional_positive_integer<T>(&mut self, name: &str) -> Option<T>
    where
        T: FromStr + PartialOrd + Default,
    {
        let raw = self.raw(name)?.to_string();
        let parsed: T = self.parse(name, &raw, A_WHOLE_NUMBER)?;

        if parsed > T::default() {
            Some(parsed)
        } else {
            self.errors.push(Error::invalid(
                name,
                "a positive integer when provided",
                raw,
            ));
            None
        }
    }

    // -- anything with a `FromStr` ----------------------------------------

    /// Any [`FromStr`] value that must be set.
    ///
    /// `expected` is the noun phrase the error message uses: `a socket
    /// address`, `an RFC 3339 timestamp`, `a log level`. It is the whole
    /// difference between a message somebody can act on and one they
    /// cannot, so it is required rather than derived from the type name.
    ///
    /// Returns `None` on either failure, having recorded it.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::net::IpAddr;
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("BIND", "10.0.0.1"), ("PEER", "not-an-ip")]);
    ///
    /// assert_eq!(
    ///     reader.required_parse::<IpAddr>("BIND", "an IP address"),
    ///     Some("10.0.0.1".parse().unwrap())
    /// );
    /// assert_eq!(reader.required_parse::<IpAddr>("PEER", "an IP address"), None);
    ///
    /// let errors = reader.finish().unwrap_err();
    /// assert!(errors.to_string().contains("PEER must be an IP address"));
    /// ```
    pub fn required_parse<T>(&mut self, name: &str, expected: &str) -> Option<T>
    where
        T: FromStr,
    {
        match self.raw(name) {
            None => {
                self.errors.push(Error::missing(name));
                None
            }
            Some(value) => {
                let value = value.to_string();
                self.parse(name, &value, expected)
            }
        }
    }

    /// Any [`FromStr`] value that need not be set.
    ///
    /// Absent is `None` with no error; present-but-unparseable is `None`
    /// with one.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::path::PathBuf;
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("CA_BUNDLE", "/etc/ca.pem")]);
    /// assert_eq!(
    ///     reader.optional_parse::<PathBuf>("CA_BUNDLE", "a path"),
    ///     Some(PathBuf::from("/etc/ca.pem"))
    /// );
    /// assert_eq!(reader.optional_parse::<PathBuf>("OTHER", "a path"), None);
    /// assert!(reader.finish().is_ok());
    /// ```
    pub fn optional_parse<T>(&mut self, name: &str, expected: &str) -> Option<T>
    where
        T: FromStr,
    {
        let value = self.raw(name)?.to_string();
        self.parse(name, &value, expected)
    }

    /// Any [`FromStr`] value with a fallback.
    ///
    /// As with [`Reader::integer_or`], an unparseable value is a recorded
    /// error rather than a silent fallback.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::net::IpAddr;
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
    /// let bind: IpAddr = reader.parse_or("BIND", "an IP address", "127.0.0.1".parse().unwrap());
    ///
    /// assert_eq!(bind.to_string(), "127.0.0.1");
    /// assert!(reader.finish().is_ok());
    /// ```
    pub fn parse_or<T>(&mut self, name: &str, expected: &str, default: T) -> T
    where
        T: FromStr,
    {
        match self.raw(name) {
            None => default,
            Some(value) => {
                let value = value.to_string();
                self.parse(name, &value, expected).unwrap_or(default)
            }
        }
    }

    // -- booleans ---------------------------------------------------------

    /// A boolean with a fallback, read strictly by [`crate::parse_bool`].
    ///
    /// A value that is neither a true spelling nor a false one is a
    /// recorded error, not a silent fallback.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("TRACING", "off"), ("CACHE", "maybe")]);
    /// assert!(!reader.bool_or("TRACING", true));
    /// assert!(reader.bool_or("METRICS", true), "absent takes the default");
    /// assert!(reader.bool_or("CACHE", true), "unparseable takes it too, but records");
    ///
    /// let errors = reader.finish().unwrap_err();
    /// assert_eq!(errors.len(), 1);
    /// assert!(errors.to_string().contains("CACHE"));
    /// ```
    pub fn bool_or(&mut self, name: &str, default: bool) -> bool {
        let Some(raw) = self.raw(name) else {
            return default;
        };
        let raw = raw.to_string();

        if let Some(parsed) = parse_bool(Some(&raw)) {
            parsed
        } else {
            self.errors.push(Error::invalid(
                name,
                "true, 1, yes, on, false, 0, no or off",
                raw,
            ));
            default
        }
    }

    /// A boolean with a fallback, read leniently by
    /// [`crate::parse_bool_lenient`]: anything not false-ish is true.
    ///
    /// Never records an error, because there is no value it cannot read.
    /// See [`crate::parse_bool_lenient`] for when that is what you want and
    /// when it is not.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("LEGACY_FLAG", "disabled")]);
    /// assert!(reader.lenient_bool_or("LEGACY_FLAG", false), "not a false spelling");
    /// ```
    #[must_use]
    pub fn lenient_bool_or(&self, name: &str, default: bool) -> bool {
        parse_bool_lenient(self.raw(name)).unwrap_or(default)
    }

    // -- lists ------------------------------------------------------------

    /// A comma-separated list, possibly empty.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let reader = Reader::from_pairs([("UPSTREAMS", "a, b")]);
    /// assert_eq!(reader.list("UPSTREAMS"), ["a", "b"]);
    /// assert!(reader.list("ABSENT").is_empty());
    /// ```
    #[must_use]
    pub fn list(&self, name: &str) -> Vec<String> {
        parse_csv(self.raw(name))
    }

    /// A comma-separated list that must be set and must have an element.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("BAD", " , ")]);
    /// assert!(reader.required_list("ABSENT").is_empty());
    /// assert!(reader.required_list("BAD").is_empty());
    /// // One missing, one set to nothing but separators.
    /// assert_eq!(reader.finish().unwrap_err().len(), 2);
    /// ```
    pub fn required_list(&mut self, name: &str) -> Vec<String> {
        let Some(value) = self.raw(name) else {
            self.errors.push(Error::missing(name));
            return Vec::new();
        };
        let value = value.to_string();
        let parsed = parse_csv(Some(&value));

        if parsed.is_empty() {
            self.errors.push(Error::invalid(
                name,
                "a comma-separated list with at least one value",
                value,
            ));
        }
        parsed
    }

    /// A comma-separated list, falling back to a default list when the
    /// variable is absent.
    ///
    /// A variable set to only separators is a recorded error rather than an
    /// empty list, because it means someone meant to configure something.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("BAD", " , ")]);
    /// assert_eq!(reader.list_or("METHODS", "GET,HEAD"), ["GET", "HEAD"]);
    /// assert!(reader.list_or("BAD", "x").is_empty());
    /// assert_eq!(reader.finish().unwrap_err().len(), 1);
    /// ```
    pub fn list_or(&mut self, name: &str, default: &str) -> Vec<String> {
        match self.raw(name) {
            None => parse_csv(Some(default)),
            Some(value) => {
                let value = value.to_string();
                let parsed = parse_csv(Some(&value));
                if parsed.is_empty() {
                    self.errors.push(Error::invalid(
                        name,
                        "a comma-separated list with at least one value",
                        value,
                    ));
                }
                parsed
            }
        }
    }

    // -- fixed sets -------------------------------------------------------

    /// A value that must be set and must be one of a fixed set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// const LEVELS: &[&str] = &["trace", "debug", "info", "warn", "error"];
    ///
    /// let mut reader = Reader::from_pairs([("LOG_LEVEL", "verbose")]);
    /// assert_eq!(reader.required_one_of("LOG_LEVEL", LEVELS), None);
    ///
    /// let errors = reader.finish().unwrap_err();
    /// assert!(errors.to_string().contains("one of trace, debug, info, warn, error"));
    /// ```
    pub fn required_one_of(&mut self, name: &str, accepted: &[&str]) -> Option<String> {
        if self.raw(name).is_none() {
            self.errors.push(Error::missing(name));
            return None;
        }
        self.optional_one_of(name, accepted)
    }

    /// A value that, when set, must be one of a fixed set.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// const LEVELS: &[&str] = &["trace", "debug", "info", "warn", "error"];
    ///
    /// let mut reader = Reader::from_pairs([("LOG_LEVEL", "debug")]);
    /// assert_eq!(reader.optional_one_of("LOG_LEVEL", LEVELS).as_deref(), Some("debug"));
    /// assert_eq!(reader.optional_one_of("OTHER", LEVELS), None);
    /// assert!(reader.finish().is_ok());
    /// ```
    pub fn optional_one_of(&mut self, name: &str, accepted: &[&str]) -> Option<String> {
        let value = self.raw(name)?.to_string();

        if accepted.contains(&value.as_str()) {
            Some(value)
        } else {
            self.errors.push(Error::invalid(
                name,
                format!("one of {}", accepted.join(", ")),
                value,
            ));
            None
        }
    }

    // -- UUIDs ------------------------------------------------------------

    /// A required UUID.
    ///
    /// Returns [`uuid::Uuid::nil`] and records a problem when the variable
    /// is absent or unparseable, so reading continues like every other
    /// getter here.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([
    ///     ("BATCH_ID", "00000000-0000-0000-0000-000000000001"),
    /// ]);
    /// assert_eq!(
    ///     reader.required_uuid("BATCH_ID").to_string(),
    ///     "00000000-0000-0000-0000-000000000001"
    /// );
    /// ```
    #[cfg(feature = "uuid")]
    pub fn required_uuid(&mut self, name: &str) -> uuid::Uuid {
        self.required_parse(name, "a UUID")
            .unwrap_or_else(uuid::Uuid::nil)
    }

    /// An optional UUID.
    #[cfg(feature = "uuid")]
    pub fn optional_uuid(&mut self, name: &str) -> Option<uuid::Uuid> {
        self.optional_parse(name, "a UUID")
    }

    // -- problems the caller finds ----------------------------------------

    /// Record that one variable held a value this crate cannot check.
    ///
    /// [`optional_one_of`](Reader::optional_one_of) covers a fixed set of
    /// accepted strings, and [`optional_parse`](Reader::optional_parse)
    /// covers anything with a [`FromStr`]. This is for what neither can: a
    /// value that has to be resolved against something outside this crate,
    /// where only the caller knows what "valid" means. The problem joins
    /// the others, so a program that rejects a value here still reports
    /// every *other* problem in the same breath.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("TENANT", "unknown-tenant")]);
    ///
    /// if let Some(value) = reader.optional_string("TENANT") {
    ///     if !["alpha", "beta"].contains(&value.as_str()) {
    ///         reader.invalid("TENANT", "a tenant this build knows about", value);
    ///     }
    /// }
    ///
    /// let errors = reader.finish().unwrap_err();
    /// assert!(errors.to_string().contains("a tenant this build knows about"));
    /// ```
    pub fn invalid(
        &mut self,
        name: impl Into<String>,
        expected: impl Into<String>,
        got: impl Into<String>,
    ) {
        self.errors.push(Error::invalid(name, expected, got));
    }

    /// Record a conflict between variables that are individually fine.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("QUEUE_NAME", "q"), ("TOPIC_NAME", "t")]);
    /// if reader.is_set("QUEUE_NAME") && reader.is_set("TOPIC_NAME") {
    ///     reader.conflict("Cannot specify both QUEUE_NAME and TOPIC_NAME.");
    /// }
    /// assert!(reader.finish().is_err());
    /// ```
    pub fn conflict(&mut self, message: impl Into<String>) {
        self.errors.push(Error::conflict(message));
    }

    // -- finishing --------------------------------------------------------

    /// Whether anything has gone wrong so far.
    ///
    /// Lets a caller skip a cross-field check that would only produce noise
    /// on top of an already-broken configuration.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
    /// assert!(!reader.has_errors());
    /// let _ = reader.required_string("SERVICE_NAME");
    /// assert!(reader.has_errors());
    /// ```
    #[must_use]
    pub fn has_errors(&self) -> bool {
        !self.errors.is_empty()
    }

    /// How many problems have been found so far.
    #[must_use]
    pub fn error_count(&self) -> usize {
        self.errors.len()
    }

    /// Finish reading.
    ///
    /// # Errors
    ///
    /// Returns every problem found, in the order it was found, when there
    /// was at least one.
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::Reader;
    ///
    /// let mut reader = Reader::from_pairs([("SERVICE_NAME", "orders")]);
    /// let _ = reader.required_string("SERVICE_NAME");
    /// assert!(reader.finish().is_ok());
    /// ```
    pub fn finish(self) -> Result<(), Errors> {
        if self.errors.is_empty() {
            Ok(())
        } else {
            Err(Errors::new(self.errors))
        }
    }

    /// Finish reading, returning `value` when nothing went wrong.
    ///
    /// The shape that lets a `Config` be built and validated in one
    /// expression, so a caller cannot forget the `finish`.
    ///
    /// # Errors
    ///
    /// Returns every problem found, as [`Reader::finish`].
    ///
    /// # Examples
    ///
    /// ```
    /// use env_reader::{Errors, Reader};
    ///
    /// #[derive(Debug)]
    /// struct Config {
    ///     port: u16,
    /// }
    ///
    /// fn load() -> Result<Config, Errors> {
    ///     let mut reader = Reader::from_pairs([("PORT", "8443")]);
    ///     let config = Config {
    ///         port: reader.integer_or("PORT", 8080),
    ///     };
    ///     reader.finish_with(config)
    /// }
    ///
    /// assert_eq!(load()?.port, 8443);
    /// # Ok::<(), Errors>(())
    /// ```
    pub fn finish_with<T>(self, value: T) -> Result<T, Errors> {
        self.finish().map(|()| value)
    }

    /// Parse a value, recording a problem and returning `None` when it does
    /// not parse.
    fn parse<T: FromStr>(&mut self, name: &str, value: &str, expected: &str) -> Option<T> {
        if let Ok(parsed) = value.parse::<T>() {
            Some(parsed)
        } else {
            self.errors.push(Error::invalid(name, expected, value));
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn every_problem_is_reported_at_once() {
        // The reason this crate is shaped the way it is.
        let mut reader = Reader::from_pairs([("PORT", "two")]);
        let _ = reader.required_string("SERVICE_NAME");
        let _ = reader.required_string("REGION");
        let _: u16 = reader.integer_or("PORT", 8080);

        let errors = reader.finish().unwrap_err();
        assert_eq!(errors.len(), 3);
        assert_eq!(errors.to_string().lines().count(), 3);
    }

    #[test]
    fn problems_come_back_in_the_order_they_were_found() {
        let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
        let _ = reader.required_string("FIRST");
        let _ = reader.required_string("SECOND");

        let errors = reader.finish().unwrap_err();
        let names: Vec<_> = errors.iter().filter_map(Error::name).collect();
        assert_eq!(names, ["FIRST", "SECOND"]);
    }

    #[test]
    fn a_blank_integer_is_absent_rather_than_a_parse_failure() {
        // The trap: `int("")` in the language this pattern usually comes
        // from raises, so a blank variable becomes a crash rather than a
        // default.
        let mut reader = Reader::from_pairs([("A", "  ")]);
        assert_eq!(reader.optional_integer::<u32>("A"), None);
        assert_eq!(reader.integer_or::<u32>("A", 7), 7);
        assert!(reader.finish().is_ok());
    }

    #[test]
    fn an_unparseable_value_does_not_silently_take_the_default() {
        // A program quietly running on a default nobody chose is harder to
        // diagnose than one that will not start.
        let mut reader = Reader::from_pairs([("PORT", "eighty")]);
        assert_eq!(reader.integer_or::<u16>("PORT", 8080), 8080);
        assert!(reader.has_errors());
    }

    #[test]
    fn a_failed_getter_still_returns_something_usable() {
        // What lets a caller read a whole configuration without `?` after
        // every line.
        let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
        assert_eq!(reader.required_string("A"), "");
        assert_eq!(reader.required_integer::<u16>("B"), 0);
        assert!(reader.required_list("C").is_empty());
        assert_eq!(reader.error_count(), 3);
    }

    #[test]
    fn any_from_str_type_can_be_read() {
        use std::net::{IpAddr, SocketAddr};
        use std::path::PathBuf;

        let mut reader = Reader::from_pairs([
            ("BIND", "10.0.0.1"),
            ("PEER", "10.0.0.2:9000"),
            ("BUNDLE", "/etc/ca.pem"),
        ]);

        assert_eq!(
            reader.required_parse::<IpAddr>("BIND", "an IP address"),
            Some("10.0.0.1".parse().unwrap())
        );
        assert_eq!(
            reader.required_parse::<SocketAddr>("PEER", "a socket address"),
            Some("10.0.0.2:9000".parse().unwrap())
        );
        assert_eq!(
            reader.optional_parse::<PathBuf>("BUNDLE", "a path"),
            Some(PathBuf::from("/etc/ca.pem"))
        );
        assert!(reader.finish().is_ok());
    }

    #[test]
    fn the_expected_phrase_reaches_the_message() {
        // The whole difference between a message somebody can act on and
        // one they cannot.
        use std::net::IpAddr;

        let mut reader = Reader::from_pairs([("BIND", "localhost")]);
        assert_eq!(reader.required_parse::<IpAddr>("BIND", "an IP address"), None);

        let errors = reader.finish().unwrap_err();
        assert_eq!(
            errors.to_string(),
            r#"invalid configuration: BIND must be an IP address, got "localhost""#
        );
    }

    #[test]
    fn a_strict_boolean_records_what_it_cannot_read() {
        let mut reader = Reader::from_pairs([("A", "on"), ("B", "disabled")]);
        assert!(reader.bool_or("A", false));
        assert!(reader.bool_or("B", true), "the default, having recorded");
        assert!(reader.bool_or("C", true), "absent takes the default silently");

        let errors = reader.finish().unwrap_err();
        assert_eq!(errors.len(), 1);
        assert_eq!(errors.iter().next().and_then(Error::name), Some("B"));
    }

    #[test]
    fn a_lenient_boolean_records_nothing() {
        let mut reader = Reader::from_pairs([("B", "disabled")]);
        assert!(reader.lenient_bool_or("B", false));
        assert!(!reader.lenient_bool_or("C", false));
        let _ = reader.bool_or("ABSENT", true);
        assert!(reader.finish().is_ok());
    }

    #[test]
    fn a_positive_integer_rejects_zero_but_not_absence() {
        let mut reader = Reader::from_pairs([("A", "0")]);
        assert_eq!(reader.optional_positive_integer::<u32>("A"), None);
        assert_eq!(reader.optional_positive_integer::<u32>("ABSENT"), None);
        assert_eq!(reader.error_count(), 1, "only the configured zero");
    }

    #[test]
    fn a_fixed_set_lists_what_it_accepted() {
        const LEVELS: &[&str] = &["info", "warn"];

        let mut reader = Reader::from_pairs([("L", "verbose")]);
        assert_eq!(reader.optional_one_of("L", LEVELS), None);
        assert_eq!(reader.required_one_of("M", LEVELS), None);

        let text = reader.finish().unwrap_err().to_string();
        assert!(text.contains("one of info, warn"), "{text}");
        assert!(text.contains("missing required configuration: M"), "{text}");
    }

    #[test]
    fn a_required_fixed_set_reports_missing_once_not_twice() {
        // The trap in delegating to the optional form: an absent variable
        // must not be both "missing" and "not one of".
        const LEVELS: &[&str] = &["info"];

        let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
        assert_eq!(reader.required_one_of("L", LEVELS), None);
        assert_eq!(reader.error_count(), 1);
    }

    #[test]
    fn a_list_of_only_separators_is_a_problem_not_an_empty_list() {
        // It means someone meant to configure something.
        let mut reader = Reader::from_pairs([("A", " , ")]);
        assert!(reader.list_or("A", "x").is_empty());
        assert!(reader.list("A").is_empty(), "the plain reader has no opinion");
        assert_eq!(reader.error_count(), 1);
    }

    #[test]
    fn finish_with_carries_a_value_through() {
        let mut reader = Reader::from_pairs([("PORT", "8443")]);
        let port = reader.integer_or::<u16>("PORT", 8080);
        assert_eq!(reader.finish_with(port).unwrap(), 8443);

        let mut reader = Reader::from_pairs([] as [(&str, &str); 0]);
        let _ = reader.required_string("A");
        assert!(reader.finish_with(1).is_err());
    }

    #[test]
    fn blank_is_absent_everywhere_it_matters() {
        let mut reader = Reader::from_pairs([
            ("S", "   "),
            ("I", "\t"),
            ("B", " "),
            ("L", ""),
            ("K", "  "),
        ]);

        assert_eq!(reader.optional_string("S"), None);
        assert_eq!(reader.optional_integer::<u32>("I"), None);
        assert!(!reader.lenient_bool_or("B", false));
        assert!(reader.list("L").is_empty());
        assert!(reader.optional_secret("K").is_none());
        assert!(!reader.is_set("S"));
        assert!(reader.finish().is_ok(), "none of that is a problem");
    }

    #[test]
    fn a_reader_can_come_from_the_process_environment() {
        // Constructing it is the whole assertion: this is the one path that
        // touches global state, and it must not panic on whatever is there.
        let reader = Reader::from_env();
        assert!(!reader.has_errors());
    }

    #[cfg(feature = "uuid")]
    #[test]
    fn a_uuid_is_read_and_a_bad_one_is_recorded() {
        let mut reader = Reader::from_pairs([
            ("GOOD", "00000000-0000-0000-0000-000000000001"),
            ("BAD", "not-a-uuid"),
        ]);

        assert_eq!(
            reader.required_uuid("GOOD").to_string(),
            "00000000-0000-0000-0000-000000000001"
        );
        assert!(reader.required_uuid("BAD").is_nil());
        assert!(reader.optional_uuid("ABSENT").is_none());

        let text = reader.finish().unwrap_err().to_string();
        assert!(text.contains("BAD must be a UUID"), "{text}");
    }
}