Struct Config 

pub struct Config { /* private fields */ }

A parsed Git configuration.

Git configuration files use an INI-like format with sections and key-value pairs. This struct provides read-only access to configuration values.

Implementations

impl Config

pub fn new() -> Self

Creates a new empty configuration.

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Parses configuration from a file.

Arguments

• path - Path to the configuration file.

Returns

A Config instance, or an error if the file cannot be read or parsed.

Note: This method does not process include directives. Use [from_file_with_includes] to process includes.

pub fn from_file_with_includes<P: AsRef<Path>>(path: P) -> Result<Self>

Parses configuration from a file, processing include directives.

This method handles Git’s include.path and includeIf directives, loading additional configuration files as specified.

Arguments

• path - Path to the configuration file.

Returns

A Config instance with all included files merged.

pub fn from_str(content: &str) -> Result<Self>

Parses configuration from a string.

Arguments

• content - The configuration file content.

Returns

A Config instance, or an error if parsing fails.

pub fn get(&self, section: &str, key: &str) -> Option<&str>

Gets a configuration value.

Arguments

• section - The section name (e.g., “user”, “core”).
• key - The key name (e.g., “name”, “email”).

Returns

The value if found, or None if the key doesn’t exist.

Example

use zerogit::config::Config;

let config = Config::from_file(".git/config").unwrap();
if let Some(name) = config.get("user", "name") {
    println!("User: {}", name);
}

pub fn get_subsection( &self, section: &str, subsection: &str, key: &str, ) -> Option<&str>

Gets a configuration value from a section with a subsection.

Arguments

• section - The section name (e.g., “remote”, “branch”).
• subsection - The subsection name (e.g., “origin”, “main”).
• key - The key name (e.g., “url”, “remote”).

Returns

The value if found, or None if the key doesn’t exist.

Example

use zerogit::config::Config;

let config = Config::from_file(".git/config").unwrap();
if let Some(url) = config.get_subsection("remote", "origin", "url") {
    println!("Origin URL: {}", url);
}

pub fn get_bool(&self, section: &str, key: &str) -> Result<bool>

Gets a configuration value as a boolean.

Git config supports various boolean representations:

• true, yes, on, 1 -> true
• false, no, off, 0 -> false

Arguments

• section - The section name.
• key - The key name.

Returns

Ok(bool) if the value exists and is a valid boolean, Ok(false) if the key doesn’t exist, Err if the value is not a valid boolean.

pub fn get_bool_subsection( &self, section: &str, subsection: &str, key: &str, ) -> Result<bool>

Gets a configuration value as a boolean from a section with a subsection.

pub fn get_int(&self, section: &str, key: &str) -> Result<i64>

Gets a configuration value as an integer.

Git config supports optional suffixes:

• k or K -> multiply by 1024
• m or M -> multiply by 1024^2
• g or G -> multiply by 1024^3

Arguments

• section - The section name.
• key - The key name.

Returns

Ok(i64) if the value exists and is a valid integer, Ok(0) if the key doesn’t exist, Err if the value is not a valid integer.

pub fn get_int_subsection( &self, section: &str, subsection: &str, key: &str, ) -> Result<i64>

Gets a configuration value as an integer from a section with a subsection.

pub fn sections(&self) -> Vec<&str>

Returns all section names in the configuration.

Returns

A vector of section names (without subsections).

pub fn subsections(&self, section: &str) -> Vec<&str>

Returns all subsections for a given section.

Arguments

• section - The section name.

Returns

A vector of subsection names. Empty subsection (“”) is excluded.

pub fn keys(&self, section: &str) -> Vec<&str>

Returns all keys in a section.

Arguments

• section - The section name.

Returns

A vector of key names.

pub fn keys_subsection(&self, section: &str, subsection: &str) -> Vec<&str>

Returns all keys in a section with a subsection.

pub fn merge(&mut self, other: &Config)

Merges another configuration into this one.

Values from other will override values in self.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.