qubit-config 0.11.2

Powerful type-safe configuration management with multi-value properties, variable substitution, and rich data type support
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

/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/

use crate::options::ConfigReadOptions;

use super::config_field::ConfigField;

/// Builder state after the field name is provided.
///
pub struct ConfigFieldBuilder<T> {
    /// The primary field name.
    pub(crate) name: String,
    /// The fallback aliases.
    pub(crate) aliases: Vec<String>,
    /// The default value.
    pub(crate) default: Option<T>,
    /// The read options.
    pub(crate) read_options: Option<ConfigReadOptions>,
}

impl<T> ConfigFieldBuilder<T> {
    /// Adds a fallback alias.
    ///
    /// # Parameters
    ///
    /// * `alias` - Fallback key checked after previous names.
    ///
    /// # Returns
    ///
    /// Updated builder.
    pub fn alias(mut self, alias: &str) -> Self {
        self.aliases.push(alias.to_string());
        self
    }

    /// Sets the default value used when all names are absent.
    ///
    /// # Parameters
    ///
    /// * `default` - Default value.
    ///
    /// # Returns
    ///
    /// Updated builder.
    pub fn default(mut self, default: T) -> Self {
        self.default = Some(default);
        self
    }

    /// Sets field-level read options.
    ///
    /// # Parameters
    ///
    /// * `read_options` - Options that override the reader's global options.
    ///
    /// # Returns
    ///
    /// Updated builder.
    pub fn read_options(mut self, read_options: ConfigReadOptions) -> Self {
        self.read_options = Some(read_options);
        self
    }

    /// Finishes the builder.
    ///
    /// # Returns
    ///
    /// A field declaration ready to be passed to [`crate::ConfigReader::read`].
    pub fn build(self) -> ConfigField<T> {
        ConfigField {
            name: self.name,
            aliases: self.aliases,
            default: self.default,
            read_options: self.read_options,
        }
    }
}