Struct git_config::fs::ConfigBuilder

pub struct ConfigBuilder { /* fields omitted */ }

Implementations

impl ConfigBuilder

pub fn new() -> Self

Constructs a new builder that finds the default location

pub fn no_system(&mut self, no_system: bool) -> &mut Self

Whether or not to skip reading settings from the system-wide $(prefix)/etc/gitconfig file. This corresponds to setting the GIT_CONFIG_NOSYSTEM environment variable.

pub fn load_environment_entries(&mut self, load_conf: bool) -> &mut Self

Whether or not to respect GIT_CONFIG_COUNT, GIT_CONFIG_KEY_<n>, and GIT_CONFIG_VALUE_<n> environment variables. By default, this is true.

pub fn system_config_path(&mut self, path: Option<PathBuf>) -> &mut Self

Override the system-wide configuration file location. Providing None or not calling this method will use the default location.

pub fn global_config_path(&mut self, path: Option<PathBuf>) -> &mut Self

Override the global (user) configuration file location. Providing None or not calling this method will use the default location.

pub fn repository_config_path(&mut self, path: Option<PathBuf>) -> &mut Self

Sets where to read the repository-specific configuration file. This is equivalent to setting GIT_CONFIG. If none is provided, then the builder will look in the default location, .git/config.

pub fn build(&self) -> Config<'_>

Builds a config, ignoring any failed configuration files.

pub fn try_build(&self) -> Result<Config<'_>, ()>

Attempts to build a config, returning error if the environment variable is invalid, if a config file is invalid, or if an overridden config file does not exist. This is only recommended when you have a very controlled system state. Otherwise, this will likely fail more often than you’d like.

Trait Implementations

impl Clone for ConfigBuilder

fn clone(&self) -> ConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigBuilder

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

Formats the value using the given formatter.

impl Default for ConfigBuilder

fn default() -> ConfigBuilder

Returns the “default value” for a type.

impl Hash for ConfigBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ConfigBuilder> for ConfigBuilder

fn eq(&self, other: &ConfigBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConfigBuilder) -> bool

This method tests for !=.

impl Eq for ConfigBuilder

impl StructuralEq for ConfigBuilder

impl StructuralPartialEq for ConfigBuilder