Struct kconfig_represent::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(
    ref_ast: &Ast,
    ref_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 main_menu_name(&self) -> String

Retrieves the name of the main menu. This serves two purposes:

1. It acquires the name for display in the User Interface
2. It acquires a needle to find the underlying menu

pub fn lookup_config_mut(
    &mut self,
    config_item_name: &str
) -> Option<&mut Box<dyn Config>>

Looks up an internal configuration item as mutable, boxed reference

pub fn lookup_config(&self, config_item_name: &str) -> Option<&Box<dyn Config>>

Looks up an internal configuration as boxed referende

pub fn lookup_menu_mut(
    &mut self,
    menu_item_name: &str
) -> Option<&mut Box<Menu>>

Looks an internal (sub)menu as mutable, boxed reference

pub fn lookup_menu(&self, menu_item_name: &str) -> Option<&Box<Menu>>

Looks up an internal (sub)menu as boxed referende

pub fn config_prompt(&self, config_item_name: &str) -> String

Finds the prompt of the given configuration item. If no prompt is found, simply returns the content of the given configuration item name.

pub fn menu_children_len(&self, menu_name: &str) -> usize

Returns the length of the children of the given (sub)menu

pub fn menu_enabled_children_len(&self, menu_name: &str) -> usize

Returns the length of the children of the given (sub)menu which are enabled.

pub fn menu_item_enabled(&self, descriptor: &MenuItemDescriptor) -> bool

Returns if a menu item is enabled, given a descriptor of the menu item.

pub fn iter_enabled_sub_descriptors(
    &self,
    menu_name: &str
) -> Box<dyn Iterator<Item = MenuItemDescriptor>>

Returns and iterator of the descriptors of children of a menu item with the given menu name, which are enabled.

pub fn menu_item_string(&self, descriptor: &MenuItemDescriptor) -> String

Returns the value as a string of the spefic menu item described by the descriptor.

pub fn descriptor_info(&self, descriptor: &MenuItemDescriptor) -> DescriptorInfo

Returns the menu item’s descriptor information, containing the Help text belonging to the given menu item indicated by the descriptor.

pub fn mutate_through_step(
    &mut self,
    config_item_name: &str
) -> Result<(), Error>

Mutates an item by stepping to the next value, this is used for values which can easily be toggled (such as a boolean configuration item).

pub fn mutate_through_string(
    &mut self,
    config_item_name: &str,
    string_value: &str
) -> Result<(), Error>

Mutates an item by loading a string value into the configuration item. Only configuration items which support the ConfigMutationMode::ThroughString are capable of loading a configuration through a string.

pub fn config_mutation_mode(&self, config_item_name: &str) -> ConfigMutationMode

Returns the mutation mode of a specific configuration item.

pub fn config_value(&self, config_item_name: &str) -> String

Returns the value of a specific configuration item.

pub fn changed(&self) -> bool

Called from the user interface to notify a change should be propagated to all configuration items present.

pub fn find_parent_menu(
    &self,
    menu_item: &MenuItemDescriptor
) -> Option<MenuItemDescriptor>

Recursively gets a (sub)menu from the current menu element by looking up the menu by name

pub fn has_default_value_set(
    &self,
    descriptor: &MenuItemDescriptor
) -> Option<bool>

Checks if the given descriptor of the given (sub)menu is using the default value or not (where applicable).

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 Default for ConfigRegistry

fn default() -> ConfigRegistry

Returns the “default value” for a type.