Enum TransportAuth 

#[non_exhaustive]
pub enum TransportAuth {
    Default,
    UsernamePassword {
        username: String,
        password: SecretString,
    },
    Token {
        username: Option<String>,
        token: SecretString,
    },
    SshKey {
        username: String,
        public_key: Option<PathBuf>,
        private_key: PathBuf,
        passphrase: Option<SecretString>,
    },
    SshAgent {
        username: String,
    },
}

Supported repository transport authentication strategies.

Credential-bearing fields are wrapped in SecretString so tokens and passwords never leak through Debug, Display, or serialization; access the plaintext intentionally with SecretString::expose only at the point it is handed to git2.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

Use default environment-driven authentication.

UsernamePassword

Use a username/password combination.

Fields

username: String

Login username.

password: SecretString

Login password.

Token

Use an HTTP token.

Fields

username: Option<String>

Optional username override; defaults to DEFAULT_TOKEN_USERNAME when None.

token: SecretString

Token or password value.

SshKey

Use explicit SSH key material.

Fields

username: String

SSH username.

public_key: Option<PathBuf>

Optional public key path.

private_key: PathBuf

Private key path.

passphrase: Option<SecretString>

Optional passphrase.

SshAgent

Use the local SSH agent.

Fields

username: String

SSH username.

Trait Implementations

impl Clone for TransportAuth

fn clone(&self) -> TransportAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransportAuth

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransportAuth

fn default() -> TransportAuth

Returns the “default value” for a type.

impl Eq for TransportAuth

impl PartialEq for TransportAuth

fn eq(&self, other: &TransportAuth) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TransportAuth