Struct git2::CredentialHelper

pub struct CredentialHelper {
    pub username: Option<String>,
    // some fields omitted
}

Management of the gitcredentials(7) interface.

Fields

username: Option<String>

A public field representing the currently discovered username from configuration.

Implementations

impl CredentialHelper

pub fn new(url: &str) -> CredentialHelper

Create a new credential helper object which will be used to probe git’s local credential configuration.

The url specified is the namespace on which this will query credentials. Invalid urls are currently ignored.

pub fn username(&mut self, username: Option<&str>) -> &mut CredentialHelper

Set the username that this credential helper will query with.

By default the username is None.

pub fn config(&mut self, config: &Config) -> &mut CredentialHelper

Query the specified configuration object to discover commands to execute, usernames to query, etc.

pub fn execute(&self) -> Option<(String, String)>

Execute this helper, attempting to discover a username/password pair.

All I/O errors are ignored, (to match git behavior), and this function only succeeds if both a username and a password were found