pub trait ConfigurationInspector:
Environment
+ Send
+ Sync {
// Required method
fn InspectConfigurationValue<'life0, 'async_trait>(
&'life0 self,
Key: String,
Overrides: ConfigurationOverridesDTO,
) -> Pin<Box<dyn Future<Output = Result<Option<InspectResultDataDTO>, CommonError>> + Send + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
}Expand description
An abstract service contract for an environment component that can inspect a configuration key to provide details about its value in all relevant scopes (e.g., default, user, workspace) and its final effective value.
This capability is used to power UIs like the “Settings” editor, which often shows where a particular setting is defined and allows the user to see inherited values.
Required Methods§
Sourcefn InspectConfigurationValue<'life0, 'async_trait>(
&'life0 self,
Key: String,
Overrides: ConfigurationOverridesDTO,
) -> Pin<Box<dyn Future<Output = Result<Option<InspectResultDataDTO>, CommonError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn InspectConfigurationValue<'life0, 'async_trait>(
&'life0 self,
Key: String,
Overrides: ConfigurationOverridesDTO,
) -> Pin<Box<dyn Future<Output = Result<Option<InspectResultDataDTO>, CommonError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Inspects a configuration key to get its value from all relevant scopes.
§Parameters
Key: The dot-separated configuration key to inspect.Overrides: A DTO specifying scope overrides (e.g., for a specific resource or language).
§Returns
A Result containing an Option<InspectResultDataDTO>, which holds
the detailed breakdown of the key’s values across all scopes. Returns
None if the key is not found in any configuration source.