Struct git_url_parse::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 that is a url used by git Internally during parsing the url is sanitized and uses the url crate to perform the majority of the parsing effort, and with some extra handling to expose metadata used my many git hosting services

Fields

host: Option<String>

The fully qualified domain name (FQDN) or IP of the repo

name: String

The name of the repo

owner: Option<String>

The owner/account/project name

organization: Option<String>

The organization name. Supported by Azure DevOps

fullname: String

The full name of the repo, formatted as “owner/name”

scheme: Scheme

The git url scheme

user: Option<String>

The authentication user

token: Option<String>

The oauth token (could appear in the https urls)

port: Option<u16>

The non-conventional port where git service is hosted

path: String

The path to repo w/ respect to user + hostname

git_suffix: bool

Indicate if url uses the .git suffix

scheme_prefix: bool

Indicate if url explicitly uses its 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>

Returns a Result<GitUrl> after normalizing and parsing url for metadata

Trait Implementations

impl Clone for GitUrl

fn clone(&self) -> GitUrl

Returns a copy 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 = Report

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<GitUrl> for GitUrl

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for GitUrl

impl StructuralEq for GitUrl

impl StructuralPartialEq for GitUrl