Enum ParseError

pub enum ParseError {
    UnsupportedUrlScheme,
    MissingRequiredField(PurlField),
    InvalidPackageType,
    InvalidQualifier,
    InvalidEscape,
}

An error returned when trying to parse an invalid PURL.

Variants

UnsupportedUrlScheme

The URL scheme is not pkg.

Example

use std::str::FromStr;

use purl::{GenericPurl, ParseError};

assert!(matches!(
    GenericPurl::<String>::from_str("http://example.com"),
    Err(ParseError::UnsupportedUrlScheme),
));

MissingRequiredField(PurlField)

The PURL is incomplete.

Example

use std::str::FromStr;

use purl::{GenericPurl, ParseError, PurlField};

assert!(matches!(
    GenericPurl::<String>::from_str("pkg:npm"),
    Err(ParseError::MissingRequiredField(PurlField::Name)),
));

InvalidPackageType

The package type contains invalid characters.

Example

use std::str::FromStr;

use purl::{GenericPurl, ParseError};

assert!(matches!(
    // Because the package type was omitted,
    // the namespace is seen to be the package type.
    GenericPurl::<String>::from_str("pkg:@acme/example"),
    Err(ParseError::InvalidPackageType),
));

InvalidQualifier

The PURL contains invalid qualifiers.

Example

use std::str::FromStr;

use purl::{GenericPurl, ParseError};

assert!(matches!(
    GenericPurl::<String>::from_str("pkg:npm/example?="),
    Err(ParseError::InvalidQualifier),
));

InvalidEscape

The PURL contains illegal escaped characters.

Example

use std::str::FromStr;

use purl::{GenericPurl, ParseError};

assert!(matches!(
    GenericPurl::<String>::from_str("pkg:npm/%80"),
    Err(ParseError::InvalidEscape),
));

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Infallible> for ParseError

fn from(_: Infallible) -> Self

Converts to this type from the input type.

impl From<ParseError> for PackageError

Available on crate feature package-type only.

fn from(source: ParseError) -> Self

Converts to this type from the input type.