Struct Purl 

pub struct Purl {
    pub purl_type: String,
    pub namespace: Option<String>,
    pub name: String,
    pub version: Option<String>,
}

A Package URL builder for creating valid PURL strings.

PURLs are a standardized way to identify software packages across different ecosystems. This struct provides a builder pattern for constructing valid PURL strings.

Format

pkg:type/namespace/name@version?qualifiers#subpath

• type (required): Package ecosystem (npm, maven, pypi, etc.)
• namespace (optional): Package scope/group (e.g., Maven groupId, npm scope)
• name (required): Package name
• version (optional): Specific version

Example

use vulnera_advisor::Purl;

// Scoped npm package
let purl = Purl::new("npm", "core")
    .with_namespace("@angular")
    .with_version("12.0.0")
    .to_string();
assert_eq!(purl, "pkg:npm/%40angular/core@12.0.0");

Fields

purl_type: String

Package type (ecosystem).

namespace: Option<String>

Optional namespace (e.g., Maven groupId, npm scope).

name: String

Package name.

version: Option<String>

Optional version.

Implementations

impl Purl

pub fn new(ecosystem: impl Into<String>, name: impl Into<String>) -> Self

Create a new PURL with the given ecosystem and package name.

The ecosystem is automatically mapped to the correct PURL type (e.g., “crates.io” → “cargo”, “PyPI” → “pypi”).

Arguments

• ecosystem - The package ecosystem (e.g., “npm”, “crates.io”, “PyPI”)
• name - The package name

Example

use vulnera_advisor::Purl;

let purl = Purl::new("crates.io", "serde");
assert_eq!(purl.purl_type, "cargo");

pub fn new_validated( ecosystem: impl Into<String>, name: impl Into<String>, ) -> Result<Self, PurlError>

Create a new PURL with validation.

Returns an error if the ecosystem is not in the known list.

Example

use vulnera_advisor::Purl;

// Valid ecosystem
let purl = Purl::new_validated("npm", "lodash").unwrap();

// Invalid ecosystem
let result = Purl::new_validated("invalid", "package");
assert!(result.is_err());

pub fn is_known_ecosystem(purl_type: &str) -> bool

Check if an ecosystem type is in the known list.

pub fn with_namespace(self, namespace: impl Into<String>) -> Self

Add a namespace (e.g., Maven groupId, npm scope like “@angular”).

pub fn with_version(self, version: impl Into<String>) -> Self

Add a version.

pub fn parse(s: &str) -> Result<Self, PurlError>

Parse a PURL string into a Purl struct.

Example

use vulnera_advisor::Purl;

let purl = Purl::parse("pkg:npm/lodash@4.17.20").unwrap();
assert_eq!(purl.purl_type, "npm");
assert_eq!(purl.name, "lodash");
assert_eq!(purl.version, Some("4.17.20".to_string()));

pub fn ecosystem(&self) -> String

Get the ecosystem name (reverse mapping from PURL type).

Returns the common ecosystem name for known mappings, or the PURL type itself if no mapping exists.

pub fn cache_key(&self) -> String

Generate a hash suitable for use as a cache key.

This creates a deterministic hash of the PURL for use in Redis cache keys.

pub fn cache_key_from_str(purl: &str) -> String

Generate a cache key from a PURL string.

Trait Implementations

impl Clone for Purl

fn clone(&self) -> Purl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Purl

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

Formats the value using the given formatter.

impl Display for Purl

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

Formats the value using the given formatter.

impl Hash for Purl

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

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

impl StructuralPartialEq for Purl