Struct GitUrl 

pub struct GitUrl {
    pub host: Option<String>,
    pub name: String,
    pub owner: Option<String>,
    pub organization: Option<String>,
    pub fullname: String,
    pub scheme: Scheme,
    pub user: Option<String>,
    pub token: Option<String>,
    pub port: Option<u16>,
    pub path: String,
    pub git_suffix: bool,
    pub scheme_prefix: bool,
}

GitUrl represents an input URL used by git hosting tools and repositories.

Parsing normalizes the input first, then uses the url crate for the generic URL handling before extracting Git-specific metadata.

Fields

host: Option<String>

The fully qualified domain name (FQDN) or IP address of the repository.

name: String

The repository name with any trailing .git suffix removed.

owner: Option<String>

The owner, account, or project segment directly associated with name.

organization: Option<String>

The organization segment when the host encodes one explicitly.

Azure DevOps URLs currently populate this field.

fullname: String

The canonical repository path assembled from the extracted metadata.

scheme: Scheme

The parsed transport or file scheme.

user: Option<String>

The authentication username embedded in the input URL.

token: Option<String>

The password or token component embedded in the input URL.

port: Option<u16>

The explicit port number when one is present.

path: String

The normalized path portion relative to the host and auth fields.

git_suffix: bool

Whether the original path ended with .git.

scheme_prefix: bool

Whether the original input explicitly spelled out its URL scheme.

Implementations

impl GitUrl

pub fn trim_auth(&self) -> GitUrl

Returns GitUrl after removing user and token values Intended use-case is for non-destructive printing GitUrl excluding any embedded auth info

pub fn parse(url: &str) -> Result<GitUrl, FromStrError>

Normalizes and parses url for metadata

Trait Implementations

impl Clone for GitUrl

fn clone(&self) -> GitUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitUrl

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

Formats the value using the given formatter.

impl Default for GitUrl

fn default() -> Self

Returns the “default value” for a type.

impl Display for GitUrl

Build the printable GitUrl from its components

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

Formats the value using the given formatter.

impl FromStr for GitUrl

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for GitUrl

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for GitUrl

impl StructuralPartialEq for GitUrl