Struct git_global::Config

pub struct Config {
    pub basedir: PathBuf,
    pub follow_symlinks: bool,
    pub same_filesystem: bool,
    pub ignored_patterns: Vec<String>,
    pub default_cmd: String,
    pub show_untracked: bool,
    pub cache_file: Option<PathBuf>,
    pub manpage_file: Option<PathBuf>,
}

A container for git-global configuration options.

Fields

basedir: PathBuf

The base directory to walk when searching for git repositories.

Default: $HOME.

follow_symlinks: bool

Whether to follow symbolic links when searching for git repos.

Default: true

same_filesystem: bool

Whether to stay on the same filesystem (as basedir) when searching for git repos on Unix or Windows.

Default: true [on supported platforms]

ignored_patterns: Vec<String>

Path patterns to ignore when searching for git repositories.

Default: none

default_cmd: String

The git-global subcommand to run when unspecified.

Default: status

show_untracked: bool

Whether to show untracked files in output.

Default: true

cache_file: Option<PathBuf>

Optional path to a cache file for git-global’s usage.

Default: repos.txt in the user’s XDG cache directory, if we understand XDG for the host system.

manpage_file: Option<PathBuf>

Optional path to our manpage, regardless of whether it’s installed.

Default: git-global.1 in the relevant manpages directory, if we understand where that should be for the host system.

Implementations

impl Config

pub fn new() -> Self

Create a new Config with the default behavior, first checking global git config options in ~/.gitconfig, then using defaults:

pub fn get_repos(&mut self) -> Vec<Repo>

Returns all known git repos, populating the cache first, if necessary.

pub fn clear_cache(&mut self)

Clears the cache of known git repos, forcing a re-scan on the next get_repos() call.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.