qubit-config 0.11.1

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

/*******************************************************************************
 *
 *    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_name_builder::ConfigFieldNameBuilder;

/// Field-level read declaration for [`crate::ConfigReader::read`].
///
#[derive(Debug, Clone, PartialEq)]
pub struct ConfigField<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> ConfigField<T> {
    /// Starts building a field declaration.
    ///
    /// # Returns
    ///
    /// A builder requiring a primary field name before `build` is available.
    pub fn builder() -> ConfigFieldNameBuilder<T> {
        ConfigFieldNameBuilder {
            aliases: Vec::new(),
            default: None,
            read_options: None,
            marker: PhantomData,
        }
    }
}