Struct git_config::file::from_paths::Options

pub struct Options<'a> {
    pub git_install_dir: Option<&'a Path>,
    pub max_depth: u8,
    pub error_on_max_depth_exceeded: bool,
    pub git_dir: Option<&'a Path>,
    pub branch_name: Option<&'a FullNameRef>,
}

Options when loading git config using File::from_paths().

Fields

git_install_dir: Option<&'a Path>

The location where gitoxide or git is installed

max_depth: u8

The maximum allowed length of the file include chain built by following nested resolve_includes where base level is depth = 0.

error_on_max_depth_exceeded: bool

When max depth is exceeded while following nested included, return an error if true or silently stop following resolve_includes.

Setting this value to false allows to read configuration with cycles, which otherwise always results in an error.

git_dir: Option<&'a Path>

The location of the .git directory

branch_name: Option<&'a FullNameRef>

The name of the branch that is currently checked out

Trait Implementations

impl<'a> Clone for Options<'a>

fn clone(&self) -> Options<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for Options<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for Options<'a>