Struct gix::Url

pub struct Url {
    pub scheme: Scheme,
    pub port: Option<u16>,
    pub path: BString,
    /* private fields */
}

A URL with support for specialized git related capabilities.

Additionally there is support for deserialization and serialization (see the Display::fmt() implementation).

Deviation

Note that we do not support passing the password using the URL as it’s likely leading to accidents.

Fields

scheme: Scheme

The URL scheme.

port: Option<u16>

The port to use when connecting to a host. If None, standard ports depending on scheme will be used.

path: BString

The path portion of the URL, usually the location of the git repository.

Security-Warning

URLs allow paths to start with - which makes it possible to mask command-line arguments as path which then leads to the invocation of programs from an attacker controlled URL. See https://secure.phabricator.com/T12961 for details.

If this value is going to be used in a command-line application, call Self::path_argument_safe() instead.

Implementations

impl Url

Instantiation

pub fn from_parts( scheme: Scheme, user: Option<String>, password: Option<String>, host: Option<String>, port: Option<u16>, path: BString, serialize_alternative_form: bool ) -> Result<Url, Error>

Create a new instance from the given parts, including a password, which will be validated by parsing them back.

impl Url

Modification

pub fn set_user(&mut self, user: Option<String>) -> Option<String>

Set the given user, with None unsetting it. Returns the previous value.

impl Url

Builder

pub fn serialize_alternate_form(self, use_alternate_form: bool) -> Url

Enable alternate serialization for this url, e.g. file:///path becomes /path.

This is automatically set correctly for parsed URLs, but can be set here for urls created by constructor.

pub fn canonicalize(&mut self, current_dir: &Path) -> Result<(), Error>

Turn a file url like file://relative into file:///root/relative, hence it assures the url’s path component is absolute, using current_dir if needed to achieve that.

impl Url

Access

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

Returns the user mentioned in the url, if present.

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

Returns the password mentioned in the url, if present.

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

Returns the host mentioned in the url, if present.

Security-Warning

URLs allow hosts to start with - which makes it possible to mask command-line arguments as host which then leads to the invocation of programs from an attacker controlled URL. See https://secure.phabricator.com/T12961 for details.

If this value is going to be used in a command-line application, call Self::host_argument_safe() instead.

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

Return the host of this URL if present and if it can’t be mistaken for a command-line argument.

Use this method if the host is going to be passed to a command-line application.

pub fn path_argument_safe(&self) -> Option<&BStr>

Return the path of this URL and if it can’t be mistaken for a command-line argument. Note that it always begins with a slash, which is ignored for this comparison.

Use this method if the path is going to be passed to a command-line application.

pub fn path_is_root(&self) -> bool

Returns true if the path portion of the url is /.

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

Returns the actual or default port for use according to the url scheme. Note that there may be no default port either.

impl Url

Transformation

pub fn canonicalized(&self, current_dir: &Path) -> Result<Url, Error>

Turn a file url like file://relative into file:///root/relative, hence it assures the url’s path component is absolute, using current_dir if necessary.

impl Url

Serialization

pub fn write_to(&self, out: &mut dyn Write) -> Result<(), Error>

Write this URL losslessly to out, ready to be parsed again.

pub fn to_bstring(&self) -> BString

Transform ourselves into a binary string, losslessly, or fail if the URL is malformed due to host or user parts being incorrect.

impl Url

Deserialization

pub fn from_bytes(bytes: &BStr) -> Result<Url, Error>

Parse a URL from bytes

Trait Implementations

impl Clone for Url

fn clone(&self) -> Url

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Url

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

Formats the value using the given formatter.

impl Default for Url

fn default() -> Url

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Url

fn deserialize<__D>( __deserializer: __D ) -> Result<Url, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Url

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

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 Url

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Url> for Url

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Url> for Url

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

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

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

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

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

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

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

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

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

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

impl Serialize for Url

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&BStr> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &BStr) -> Result<Url, <Url as TryFrom<&BStr>>::Error>

Performs the conversion.

impl TryFrom<&OsStr> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &OsStr) -> Result<Url, <Url as TryFrom<&OsStr>>::Error>

Performs the conversion.

impl TryFrom<&Path> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Path) -> Result<Url, <Url as TryFrom<&Path>>::Error>

Performs the conversion.

impl TryFrom<&str> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Url, <Url as TryFrom<&str>>::Error>

Performs the conversion.

impl<'a> TryFrom<Cow<'a, BStr>> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Cow<'a, BStr> ) -> Result<Url, <Url as TryFrom<Cow<'a, BStr>>>::Error>

Performs the conversion.

impl TryFrom<PathBuf> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Url, <Url as TryFrom<PathBuf>>::Error>

Performs the conversion.

impl TryFrom<String> for Url

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Url, <Url as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for Url

impl StructuralEq for Url

impl StructuralPartialEq for Url