qubit-config 0.12.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

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

use std::marker::PhantomData;

use crate::options::ConfigReadOptions;

use super::config_field_builder::ConfigFieldBuilder;

/// Builder state before the field name is provided.
///
pub struct ConfigFieldNameBuilder<T> {
    /// 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>,
    /// The type marker.
    pub(crate) marker: PhantomData<T>,
}

impl<T> ConfigFieldNameBuilder<T> {
    /// Sets the primary field name and unlocks [`super::ConfigFieldBuilder::build`].
    ///
    /// # Parameters
    ///
    /// * `name` - Primary configuration key.
    ///
    /// # Returns
    ///
    /// Builder state with a primary name.
    pub fn name(self, name: &str) -> ConfigFieldBuilder<T> {
        ConfigFieldBuilder {
            name: name.to_string(),
            aliases: self.aliases,
            default: self.default,
            read_options: self.read_options,
        }
    }
}