Struct ConfigRegistry 

pub struct ConfigRegistry { /* private fields */ }

The ConfigRegistry is used to create a registry, which allows reading and writing a configuration to and from a .config file as defined by a Kconfig file. To present the menu, a frontend is necessary to represent the state of the registry.

Implementations

impl ConfigRegistry

pub fn new(ast: &Ast, macro_symbols: &HashSet<Symbol>) -> Result<Self, Error>

Constructs a new configuration registry, given the Abstract syntax tree as loaded from a kconfig-parser’s Ast instance, and the macro symbols discoverd by the macro lexer (if used).

pub fn items<'a>(&'a self) -> &'a HashMap<ItemReference, Item>

Return a reference to the map of the items available in the configuration registry

pub fn main_menu_name<'a>(&'a self) -> &'a str

Returns the name of the main menu

pub fn main_menu_item<'a>(&'a self) -> &'a Item

Returns the item belonging to the main menu

pub fn get<'a>(&'a self, itemref: &ItemReference) -> Option<&'a Item>

Finds the item given the item reference, if available, otherwise returns None

pub fn get_info(&self, itemref: &ItemReference) -> Option<Info>

Returns an item’s information, if available, otherwise returns None

pub fn item_enabled(&self, itemref: &ItemReference) -> Result<bool, Error>

Given the item reference, determine whether the associated item is enabled

pub fn current_config_item(&self, itemref: &ItemReference) -> Option<ConfigItem>

Returns a clone of the active configuration item, if available

pub fn mutation_start(&self, itemref: &ItemReference) -> Option<MutationStart>

Returns how to start a mutation. Given the configuration type, this can be a different start situation.

pub fn current_value(&self, itemref: &ItemReference) -> Option<Variant>

The current value of an item is resolved according to a number of rules:

If the value has been selected through a select reverse dependency, then this value will be used, with respect to it’s default value.

If the value has a “regular” value, then this value will be used

If the value has been selected through an implied value, then this value will be used, with respect to it’s default value.

Otherwise, the default value will be used.

pub fn current_value_is_default(&self, itemref: &ItemReference) -> bool

Determines whether the value if the configuration item internal to the item is set to it’s default value.

pub fn set_value( &mut self, itemref: &ItemReference, value: Variant, ) -> Result<(), Error>

Sets the value of a configuration item either by loading it from an earlier stored session, or by entering the data programmatically/through a configuration editor. Returns nothing if successful, or an error if for some reason the value could not be set properly.

pub fn discard_value(&mut self, itemref: &ItemReference) -> Result<(), Error>

Unsets the value of a configuation item

pub fn find_itemref(&self, name: &str) -> Option<ItemReference>

Finds the appropriate item reference by the name of the itemreference

pub fn reset(&mut self) -> Result<(), Error>

Evaluates all items and enforces the proper rules on all internal configuration items and dependent configuration items for all the items evaluated.

pub fn write_dotconfig_file( &self, dotconfig_filename: &str, ) -> Result<(), Error>

Writes the current configuration known to the configuration registry into a file, typically this file has the file name “.config”

pub fn write_dotconfig(&self, output: &mut dyn Write) -> Result<(), Error>

Writes the current configuration known to the configuration registry into a Write trait supporting type.

pub fn read_dotconfig_file( &mut self, dotconfig_filename: &str, ) -> Result<(), LoadError>

Reads the saved configuration from a file, typically this file has the file name “.config”, and mutates the configuration registry accordingly.

pub fn read_dotconfig(&mut self, input: &mut dyn Read) -> Result<(), LoadError>

Reads the saved configuration from a Read trait supporting type, and mutates the configuration registry accordingly.

Trait Implementations

impl Debug for ConfigRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.