Struct compose_yml::v2::GitUrl

pub struct GitUrl { /* fields omitted */ }

URL of a Git repository. Git repositories may be specified as either ordinary http or https URLs, or as scp-style remote directory specifiers.

One of the goals behind this class is to be able to use it as an "enhanced string", much like PathBuf, that can be passed to various APIs using conversion via AsRef and From. So we implement plenty of conversions, plus Ord so we can be used as a key in a BTreeMap.

Methods

impl GitUrl

pub fn should_treat_as_url<S: AsRef<str>>(s: S) -> bool

Would docker-compose interpret this string as a URL? We check against a list of known prefixes that trigger URL intepretation in docker-compose.

pub fn new<S: Into<String>>(url: S) -> Result<GitUrl>

Create a GitUrl from the specified string. Will only return an error if should_treat_as_url returns false.

pub fn to_url(&self) -> Result<Url>

Convert a GitUrl to a regular url::Url object.

pub fn without_subdirectory(&self) -> GitUrl

Returns a new GitUrl which is the same as the this one, but without any subdirectory part

pub fn repository(&self) -> &str

Extract the repository part of the URL

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

Extract the optional branch part of the git URL

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

Extract the optional subdirectory part of the git URL

Trait Implementations

impl Debug for GitUrl

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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

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

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

fn ne(&self, __arg_0: &GitUrl) -> bool

This method tests for !=.

impl Eq for GitUrl

impl PartialOrd for GitUrl

fn partial_cmp(&self, __arg_0: &GitUrl) -> Option<Ordering>

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

fn lt(&self, __arg_0: &GitUrl) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &GitUrl) -> bool

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

fn gt(&self, __arg_0: &GitUrl) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &GitUrl) -> bool

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

impl Ord for GitUrl

fn cmp(&self, __arg_0: &GitUrl) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Display for GitUrl

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

Formats the value using the given formatter.

impl AsRef<str> for GitUrl

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<OsStr> for GitUrl

Convert to an &OsStr, which makes it easier to use APIs like std::process::Command that take AsRef<OsStr> for their arguments.

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl From<GitUrl> for String

fn from(url: GitUrl) -> String

Performs the conversion.

impl From<GitUrl> for OsString

fn from(url: GitUrl) -> OsString

Performs the conversion.