Struct git_repository::discover::upwards::Options

pub struct Options {
    pub required_trust: Trust,
    pub ceiling_dirs: Vec<PathBuf, Global>,
    pub match_ceiling_dir_or_error: bool,
    pub cross_fs: bool,
}

Options to help guide the discovery of repositories, along with their options when instantiated.

Fields

required_trust: Trust

When discovering a repository, assure it has at least this trust level or ignore it otherwise.

This defaults to Reduced as our default settings are geared towards avoiding abuse. Set it to Full to only see repositories that are owned by the current user.

ceiling_dirs: Vec<PathBuf, Global>

When discovering a repository, ignore any repositories that are located in these directories or any of their parents.

match_ceiling_dir_or_error: bool

If true, and ceiling_dirs is not empty, we expect at least one ceiling directory to match or else there will be an error.

cross_fs: bool

if true avoid crossing filesystem boundaries. Only supported on Unix-like systems.

Implementations

impl Options

pub fn apply_environment(self) -> Options

Loads discovery options overrides from the environment.

The environment variables are:

• GIT_CEILING_DIRECTORIES for ceiling_dirs

Note that GIT_DISCOVERY_ACROSS_FILESYSTEM for cross_fs is not read, as it requires parsing of git-config style boolean values.

Trait Implementations

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.