Struct git_url::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.

Implementations

impl Url

Instantiation

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

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

pub fn from_parts_as_alternative_form(
    scheme: Scheme,
    user: Option<String>,
    host: Option<String>,
    port: Option<u16>,
    path: BString
) -> Result<Self, Error>

Create a new instance from the given parts, which will be validated by parsing them back from its alternative form.

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) -> Self

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) -> Result<(), Error>

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

Examples found in repository

src/lib.rs (line 165)

    pub fn canonicalized(&self) -> Result<Self, git_path::realpath::Error> {
        let mut res = self.clone();
        res.canonicalize()?;
        Ok(res)
    }

impl Url

Access

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

Returns the user mentioned in the url, if present.

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

Returns the host mentioned in the url, if present.

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) -> Result<Self, Error>

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

impl Url

Serialization

pub fn write_to(&self, out: impl Write) -> Result<()>

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

Examples found in repository

src/lib.rs (line 210)

    pub fn to_bstring(&self) -> bstr::BString {
        let mut buf = Vec::with_capacity(
            (5 + 3)
                + self.user.as_ref().map(|n| n.len()).unwrap_or_default()
                + 1
                + self.host.as_ref().map(|h| h.len()).unwrap_or_default()
                + self.port.map(|_| 5).unwrap_or_default()
                + self.path.len(),
        );
        self.write_to(&mut buf).expect("io cannot fail in memory");
        buf.into()
    }

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.

Examples found in repository

src/lib.rs (line 70)

    pub fn from_parts(
        scheme: Scheme,
        user: Option<String>,
        host: Option<String>,
        port: Option<u16>,
        path: BString,
    ) -> Result<Self, parse::Error> {
        parse(
            Url {
                scheme,
                user,
                host,
                port,
                path,
                serialize_alternative_form: false,
            }
            .to_bstring()
            .as_ref(),
        )
    }

    /// Create a new instance from the given parts, which will be validated by parsing them back from its alternative form.
    pub fn from_parts_as_alternative_form(
        scheme: Scheme,
        user: Option<String>,
        host: Option<String>,
        port: Option<u16>,
        path: BString,
    ) -> Result<Self, parse::Error> {
        parse(
            Url {
                scheme,
                user,
                host,
                port,
                path,
                serialize_alternative_form: true,
            }
            .to_bstring()
            .as_ref(),
        )
    }

impl Url

Deserialization

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

Parse a URL from bytes

Examples found in repository

src/impls.rs (line 27)

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Self::from_bytes(value.into())
    }
}

impl TryFrom<String> for Url {
    type Error = parse::Error;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::from_bytes(value.as_str().into())
    }
}

impl TryFrom<PathBuf> for Url {
    type Error = parse::Error;

    fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
        git_path::into_bstr(value).try_into()
    }
}

impl TryFrom<&Path> for Url {
    type Error = parse::Error;

    fn try_from(value: &Path) -> Result<Self, Self::Error> {
        git_path::into_bstr(value).try_into()
    }
}

impl TryFrom<&std::ffi::OsStr> for Url {
    type Error = parse::Error;

    fn try_from(value: &std::ffi::OsStr) -> Result<Self, Self::Error> {
        git_path::os_str_into_bstr(value)
            .expect("no illformed UTF-8 on Windows")
            .try_into()
    }
}

impl TryFrom<&BStr> for Url {
    type Error = parse::Error;

    fn try_from(value: &BStr) -> Result<Self, Self::Error> {
        Self::from_bytes(value)
    }

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

Formats the value using the given formatter.

impl Default for Url

fn default() -> Self

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Hash for Url

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 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::Ok, __S::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl Eq for Url

impl StructuralEq for Url

impl StructuralPartialEq for Url