Struct GitUrl 

pub struct GitUrl { /* private fields */ }

A URL reference to a Git repository.

Implementations

impl GitUrl

pub fn from_commit( url: SafeUrl, reference: GitReference, precise: GitOid, lfs: GitLfs, ) -> Result<Self, GitUrlParseError>

Create a new GitUrl from a repository URL and a precise commit.

pub fn from_fields( url: SafeUrl, reference: GitReference, precise: Option<GitOid>, lfs: GitLfs, ) -> Result<Self, GitUrlParseError>

Create a new GitUrl from a repository URL and a precise commit, if known.

pub fn with_precise(self, precise: GitOid) -> Result<Self, GitUrlParseError>

Set the precise GitOid to use for this Git URL.

pub fn with_reference(self, reference: GitReference) -> Self

Set the GitReference to use for this Git URL, clearing any resolved commit if it changes.

pub fn url(&self) -> &SafeUrl

Return the [Url] of the Git repository.

pub fn repository(&self) -> &RepositoryUrl

Return the canonical repository identity for this Git URL.

pub fn reference(&self) -> &GitReference

Return the reference to the commit to use, which could be a branch, tag or revision.

pub fn precise(&self) -> Option<GitOid>

Return the precise commit, whether requested directly or resolved from a named reference.

pub fn resolved_commit(&self) -> Option<GitOid>

Return the commit obtained by resolving a reference, if known.

Returns None when the reference is itself a full commit.

pub fn lfs(&self) -> GitLfs

Return the Git LFS configuration.

pub fn with_lfs(self, lfs: GitLfs) -> Self

Set the Git LFS configuration.

Trait Implementations

impl Clone for GitUrl

fn clone(&self) -> Self

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

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

Formats the value using the given formatter.

impl Eq for GitUrl

impl From<GitUrl> for SafeUrl

fn from(git: GitUrl) -> Self

Converts to this type from the input type.

impl Hash for GitUrl

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GitUrl

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for GitUrl

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GitUrl

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<SafeUrl> for GitUrl

fn try_from(url: SafeUrl) -> Result<Self, Self::Error>

Initialize a GitUrl source from a URL.

type Error = GitUrlParseError

The type returned in the event of a conversion error.