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
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

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

use crate::ConfigResult;
use crate::options::ConfigReadOptions;

/// Context passed to [`crate::from::FromConfig`] implementations.
///
pub struct ConfigParseContext<'a> {
    /// The root-relative configuration key.
    key: &'a str,
    /// The read options used for this parse operation.
    options: &'a ConfigReadOptions,
    /// The substitution function used for this parse operation.
    substitute: &'a dyn Fn(&str) -> ConfigResult<String>,
}

impl<'a> ConfigParseContext<'a> {
    /// Creates a parsing context.
    ///
    /// # Parameters
    ///
    /// * `key` - The root-relative configuration key.
    /// * `options` - The read options used for this parse operation.
    /// * `substitute` - The substitution function used for this parse operation.
    ///
    /// # Returns
    ///
    /// A new parsing context.
    pub(crate) fn new(
        key: &'a str,
        options: &'a ConfigReadOptions,
        substitute: &'a dyn Fn(&str) -> ConfigResult<String>,
    ) -> Self {
        Self {
            key,
            options,
            substitute,
        }
    }

    /// Gets the key being parsed.
    ///
    /// # Returns
    ///
    /// The root-relative configuration key.
    #[inline]
    pub fn key(&self) -> &str {
        self.key
    }

    /// Gets the read options used for this parse operation.
    ///
    /// # Returns
    ///
    /// Read options selected by the field or reader.
    #[inline]
    pub fn options(&self) -> &ConfigReadOptions {
        self.options
    }

    /// Applies variable substitution to a string value.
    ///
    /// # Parameters
    ///
    /// * `value` - The string value to substitute.
    ///
    /// # Returns
    ///
    /// The substituted string value.
    pub(crate) fn substitute_string(&self, value: &str) -> ConfigResult<String> {
        (self.substitute)(value)
    }
}