Struct GitUrl 

pub struct GitUrl { /* private fields */ }

Represents a parsed Git repository url

GitUrl is an input url used by git. Parsing of the url inspired by rfc3986, but does not strictly cover the spec Optional, but by default, uses the url crate to perform a final validation of the parsing effort

Implementations

impl GitUrl

pub fn port(&self) -> Option<u16>

The port number of the repo host, if specified

pub fn print_scheme(&self) -> bool

If we should print scheme:// from input or derived during parsing

pub fn hint(&self) -> GitUrlParseHint

Pattern style of url derived during parsing

impl GitUrl

pub fn scheme(&self) -> Option<&str>

scheme name (i.e. scheme://)

pub fn user(&self) -> Option<&str>

user name userinfo

pub fn password(&self) -> Option<&str>

password userinfo provided with user (i.e. user:password@…)

pub fn host(&self) -> Option<&str>

The hostname or IP of the repo host

pub fn path(&self) -> &str

File or network path to repo

pub fn trim_auth(&self) -> GitUrl

Returns GitUrl after removing all user info values

pub fn parse(input: &str) -> Result<Self, GitUrlParseError>

Returns a Result<GitUrl> after parsing input for metadata

let http_url = GitUrl::parse("https://github.com/tjtelan/git-url-parse-rs.git")?;
let ssh_url = GitUrl::parse("git@github.com:tjtelan/git-url-parse-rs.git")?;

pub fn parse_to_url(input: &str) -> Result<Url, GitUrlParseError>

Normalize input into form that can be used by Url::parse

use git_url_parse::GitUrl;
#[cfg(feature = "url")]
use url::Url;

fn main() -> Result<(), git_url_parse::GitUrlParseError> {
    let ssh_url = GitUrl::parse_to_url("git@github.com:tjtelan/git-url-parse-rs.git")?;

    assert_eq!(ssh_url.scheme(), "ssh");
    assert_eq!(ssh_url.username(), "git");
    assert_eq!(ssh_url.host_str(), Some("github.com"));
    assert_eq!(ssh_url.path(), "/tjtelan/git-url-parse-rs.git");
    Ok(())
}

pub fn provider_info<T>(&self) -> Result<T, GitUrlParseError>

where T: GitProvider<GitUrl, GitUrlParseError>,

use git_url_parse::GitUrl;
use git_url_parse::types::provider::GenericProvider;

let ssh_url = GitUrl::parse("git@github.com:tjtelan/git-url-parse-rs.git")?;
let provider : GenericProvider = ssh_url.provider_info()?;

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() -> GitUrl

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 GitProvider<GitUrl, GitUrlParseError> for AzureDevOpsProvider

fn from_git_url(url: &GitUrl) -> Result<Self, GitUrlParseError>

Trait method called by GitUrl::provider_info()

impl GitProvider<GitUrl, GitUrlParseError> for GenericProvider

fn from_git_url(url: &GitUrl) -> Result<Self, GitUrlParseError>

Trait method called by GitUrl::provider_info()

impl GitProvider<GitUrl, GitUrlParseError> for GitLabProvider

fn from_git_url(url: &GitUrl) -> Result<Self, GitUrlParseError>

Trait method called by GitUrl::provider_info()

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 TryFrom<&GitUrl> for Url

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &GitUrl) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Url> for GitUrl

type Error = GitUrlParseError

The type returned in the event of a conversion error.

fn try_from(value: &Url) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<GitUrl> for Url

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: GitUrl) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Url> for GitUrl

type Error = GitUrlParseError

The type returned in the event of a conversion error.

fn try_from(value: Url) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for GitUrl

impl StructuralPartialEq for GitUrl