Struct HostedGitInfo

pub struct HostedGitInfo { /* private fields */ }

The parsed information from a git hosting URL.

Implementations

impl HostedGitInfo

pub fn from_url(giturl: &str) -> Result<Self, ParseError>

Parses a URL string and returns a HostedGitInfo struct, if successful. If parsing fails, a ParseError will be returned.

pub fn provider(&self) -> Provider

The type of hosting provider. (GitHub, Gitlab, Bitbucket, …)

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

The name of the user or organization on the git host.

This is using an Option because some hosting providers allow projects that are not scoped to a particular user or organization.

Example: https://github.com/Turbo87/hosted-git-info-rs.git → Turbo87

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

The authentication part of the URL, if it exists.

Format: <USER>[:<PASSWORD>]

Example: https://user:password@github.com/foo/bar.git → user:password

pub fn project(&self) -> &str

The name of the project on the git host.

Example: https://github.com/Turbo87/hosted-git-info-rs.git → hosted-git-info-rs

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

The branch, tag, commit, … part of the URL, if it exists.

Example: https://github.com/Turbo87/hosted-git-info-rs.git#rust-is-awesome → rust-is-awesome

pub fn default_representation(&self) -> DefaultRepresentation

The original URL type (shortcut, https, ssh, …).

Example: https://github.com/Turbo87/hosted-git-info-rs.git → Https

Trait Implementations

impl Clone for HostedGitInfo

fn clone(&self) -> HostedGitInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostedGitInfo

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

Formats the value using the given formatter.

impl FromStr for HostedGitInfo

type Err = ParseError

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 HostedGitInfo

fn eq(&self, other: &HostedGitInfo) -> 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 HostedGitInfo

impl StructuralPartialEq for HostedGitInfo