Skip to main content

Credential

Struct Credential 

Source
pub struct Credential {
    pub protocol: Option<String>,
    pub host: Option<String>,
    pub path: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub url: Option<String>,
    pub extra: Vec<(String, String)>,
}
Expand description

A structured Git credential.

Mirrors the fields Git’s credential protocol exchanges. Round-trips through the key=value\n…\n\n wire format via Credential::parse and Credential::serialize. Any keys outside the named fields below (capability[], authtype, password_expiry_utc, …) are preserved in extra so they survive a parse/serialize round-trip and are forwarded to helpers unchanged.

Fields§

§protocol: Option<String>

protocol field (e.g. https, http, ssh).

§host: Option<String>

host field, optionally including a :port suffix.

§path: Option<String>

path field (repository path on the host).

§username: Option<String>

username field.

§password: Option<String>

password field (the secret).

§url: Option<String>

url field — a full URL Git can decompose into the fields above.

§extra: Vec<(String, String)>

Any additional key=value pairs, in wire order. Multi-valued keys such as capability[] may appear more than once.

Implementations§

Source§

impl Credential

Source

pub fn parse(input: &str) -> Self

Parse a credential from Git’s key=value\n… wire format.

Parsing stops at the first blank line (Git’s record terminator) or at EOF. Trailing \r is stripped from each line so the parser accepts both LF and CRLF input. Lines without an = are ignored.

Source

pub fn parse_bytes(bytes: &[u8]) -> Self

Parse from raw bytes (lossy UTF-8); convenience for helper stdout.

Source

pub fn serialize(&self) -> String

Serialize to Git’s key=value\n wire format (no trailing blank line).

Fields are emitted in Git’s canonical order (protocol, host, path, username, password, url) followed by any extra entries in their stored order.

Source

pub fn is_complete(&self) -> bool

True when the credential carries a usable username and password.

Source

pub fn target_url(&self) -> Option<String>

The URL this credential authenticates against, for matching credential.<url>.helper config entries. Prefers an explicit url; otherwise reconstructs it from protocol/host/path (matching Git’s credential_apply_config).

Trait Implementations§

Source§

impl Clone for Credential

Source§

fn clone(&self) -> Credential

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Credential

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Credential

Source§

fn default() -> Credential

Returns the “default value” for a type. Read more
Source§

impl Eq for Credential

Source§

impl PartialEq for Credential

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Credential

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.