Struct GitUrl 

pub struct GitUrl {
    pub repository_url: Arc<UrlRef>,
    pub repository_gix_url: Url,
    pub path: RelativePathBuf,
    /* private fields */
}

Available on crate feature git only.

A URL for an entry in a git repository.

The URL scheme is “git:”, followed by repository URL, a !, and then the entry path within the repository. The fragment of the repository URL is used to select a git tag, a commit hash in hex, or a branch name (in which case the tip of the branch will be used). The default is to use the tip of the default branch.

Note that the fragment cannot be used with local repositories, which will be accessed in their current state.

Fields

repository_url: Arc<UrlRef>

The repository URL.

repository_gix_url: Url

The repository gix Url.

path: RelativePathBuf

The entry path.

Implementations

impl GitUrl

pub fn parse(url_representation: &str) -> Result<(String, String), UrlError>

Parse.

pub fn new( context: &UrlContextRef, repository_url: Arc<UrlRef>, repository_gix_url: Url, path: RelativePathBuf, ) -> Self

Constructor.

pub fn new_with(&self, path: RelativePathBuf) -> Self

Constructor.

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

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

Formats the value using the given formatter.

impl Into<Box<dyn URL + Send + Sync>> for GitUrl

fn into(self) -> UrlRef

Converts this type into the (usually inferred) input type.

impl URL for GitUrl

fn context(&self) -> &UrlContext

The UrlContext used to create this URL.

fn query(&self) -> Option<UrlQuery>

The optional query.

fn fragment(&self) -> Option<String>

The optional fragment.

fn format(&self) -> Option<String>

Format of the URL content’s canonical representation.

fn base(&self) -> Option<UrlRef>

Returns a URL that is the equivalent of a “base directory” for the URL.

fn relative(&self, path: &str) -> UrlRef

Parses the argument as a path relative to the URL. That means that this URL is treated as a “base directory” (see base). The argument supports “..” and “.”, with the returned URL path always being absolute.

fn conform(&mut self) -> Result<(), UrlError>

Available on crate feature blocking only.

Ensures that the URL conforms with the expectations of its functions. If successful, this function may change the URL appropriately, e.g. a relative path would be turned into an absolute path.

fn conform_async(&self) -> Result<ConformFuture, UrlError>

Available on crate feature async only.

Async version of URL::conform.

fn open(&self) -> Result<ReadRef, UrlError>

Available on crate feature blocking only.

Opens the URL for reading by providing a dyn Read.

fn open_async(&self) -> Result<OpenFuture, UrlError>

Available on crate feature async only.

Async version of URL::open. Provides a dyn AsyncRead.

fn key(&self) -> String

Returns a string that uniquely identifies the URL.

fn local(&self) -> Option<PathBuf>

If this URL points to a local path, returns it.