Struct git_prompt::Options

pub struct Options<'a> {
    pub askpass: Option<Cow<'a, Path>>,
    pub mode: Mode,
}

The options used in [ask()].

Fields

askpass: Option<Cow<'a, Path>>

The path or name (for lookup in PATH) to the askpass program to call before prompting the user.

It’s called like this askpass <prompt>, but note that it won’t know if the input should be hidden or not.

mode: Mode

The way the user is prompted.

Implementations

impl Options<'_>

pub fn apply_environment(
    self,
    use_git_askpass: bool,
    use_ssh_askpass: bool,
    use_git_terminal_prompt: bool
) -> Self

Change this instance to incorporate information from the environment.

• if use_git_askpass is true, use GIT_ASKPASS to override any existing askpass program
• otherwise fall back to the askpass program already set
• or try to use the SSH_ASKPASS if use_ssh_askpass is true

At the and of this process, the askpass program may be set depending on the rules above.

Lastly, if use_git_terminal_prompt is set, use the GIT_TERMINAL_PROMPT environment variable and evaluate it as boolean, and if false, set mode to disable.

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() -> Options<'a>

Returns the “default value” for a type.