Struct packageurl::PackageUrl

pub struct PackageUrl<'a> { /* private fields */ }

A Package URL.

Implementations

impl<'a> PackageUrl<'a>

pub fn new<T, N>(ty: T, name: N) -> Result<Self>

where T: Into<Cow<'a, str>>, N: Into<Cow<'a, str>>,

Create a new Package URL with the provided type and name.

Type

The Package URL type must be valid, otherwise an error will be returned. The type can only be composed of ASCII letters and numbers, ‘.’, ‘+’ and ‘-’ (period, plus and dash). It cannot start with a number and cannot contain spaces.

Name

The package name will be canonicalize depending on the type: for instance, ‘bitbucket’ packages have a case-insensitive name, so the name will be lowercased if needed.

Example

assert!( packageurl::PackageUrl::new("cargo", "packageurl").is_ok() );
assert!( packageurl::PackageUrl::new("bad type", "packageurl").is_err() );

pub fn ty(&self) -> &str

Get the Package URL type.

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

Get the optional namespace.

pub fn name(&self) -> &str

Get the package name.

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

Get the optional package version.

pub fn qualifiers(&self) -> &HashMap<Cow<'a, str>, Cow<'a, str>>

Get the package qualifiers

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

Get the optional package subpath.

pub fn with_namespace<N>(&mut self, namespace: N) -> &mut Self

where N: Into<Cow<'a, str>>,

Assign a namespace to the package.

pub fn without_namespace(&mut self) -> &mut Self

Clear the namespace

pub fn with_version<V>(&mut self, version: V) -> &mut Self

where V: Into<Cow<'a, str>>,

Assign a version to the package.

pub fn without_version(&mut self) -> &mut Self

Clear the version

pub fn with_subpath<S>(&mut self, subpath: S) -> Result<&mut Self>

where S: Into<Cow<'a, str>>,

Assign a subpath to the package.

Subpaths must not contain empty, local (‘.’) or parent (‘..’) segments, otherwise an error will be returned.

pub fn without_subpath(&mut self) -> &mut Self

Clear the subpath

pub fn clear_qualifiers(&mut self) -> &mut Self

Clear qualifiers

pub fn add_qualifier<K, V>(&mut self, key: K, value: V) -> Result<&mut Self>

where K: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Add a qualifier to the package.

Trait Implementations

impl<'a> Clone for PackageUrl<'a>

fn clone(&self) -> PackageUrl<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PackageUrl<'a>

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

Formats the value using the given formatter.

impl Display for PackageUrl<'_>

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

Formats the value using the given formatter.

impl FromStr for PackageUrl<'static>

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<'a> PartialEq for PackageUrl<'a>

fn eq(&self, other: &PackageUrl<'a>) -> 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<'a> Eq for PackageUrl<'a>

impl<'a> StructuralPartialEq for PackageUrl<'a>