Struct SourceUrl

pub struct SourceUrl {
    pub url: Url,
    pub vcs_info: Option<VcsInfo>,
}

A URL for package sources.

Wraps the Url type and provides optional information on VCS systems.

Can be created from custom URL strings, that in part resemble the default URL syntax, e.g.:

git+https://example.org/example-project.git#tag=v1.0.0?signed

The above example provides an overview of the custom URL syntax:

• The optional VCS specifier git is prepended, directly followed by a “+” sign as delimiter,
• specific URL fragment types such as tag are used to encode information about the particular VCS objects to address,
• the URL query component signed is used to indicate that OpenPGP signature verification is required for a VCS type.

Note

The URL format used by SourceUrl deviates from the default URL syntax by allowing to change the order of the query and fragment component!

Refer to the alpm-package-source documentation for a more detailed overview of the custom URL syntax.

Examples

use std::str::FromStr;

use alpm_types::SourceUrl;

// Create Url from &str
let url =
    SourceUrl::from_str("git+https://your-vcs.org/example-project.git?signed#tag=v1.0.0")?;
assert_eq!(
    &url.to_string(),
    "git+https://your-vcs.org/example-project.git?signed#tag=v1.0.0"
);

Fields

url: Url

The URL from where the sources are retrieved.

vcs_info: Option<VcsInfo>

Optional data on VCS systems using the URL for the retrieval of sources.

Implementations

impl SourceUrl

fn parser(input: &mut &str) -> ModalResult<SourceUrl>

Parses a full SourceUrl from a string slice.

fn inner_url_parser(input: &mut &str) -> ModalResult<String>

Recognizes a URL in an alpm-package-source string.

Considers all chars until a special char or the EOF is encountered:

• # character that indicates a fragment
• ? character indicates a query
• EOF we reached the end of the string.

All of the above indicate that the end of the URL has been reached. The # or ? are not consumed, so that an outer parser may continue parsing afterwards.

Trait Implementations

impl Clone for SourceUrl

fn clone(&self) -> SourceUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceUrl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SourceUrl

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

Formats the value using the given formatter.

impl FromStr for SourceUrl

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates a new SourceUrl instance from a string slice.

Examples

use std::str::FromStr;

use alpm_types::SourceUrl;

let url =
    SourceUrl::from_str("git+https://your-vcs.org/example-project.git?signed#tag=v1.0.0")?;
assert_eq!(
    &url.to_string(),
    "git+https://your-vcs.org/example-project.git?signed#tag=v1.0.0"
);

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for SourceUrl

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SourceUrl

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceUrl

impl StructuralPartialEq for SourceUrl