packageurl/
lib.rs

1//! `packageurl` is an implementation of the [Package URL] specification for the [Rust] programming language.
2//!
3//! [Rust]: http://rust-lang.org/
4//! [Package URL]: https://github.com/package-url/purl-spec
5//!
6//!
7//! # Parsing
8//!
9//! Parse a package url after bringing the [`FromStr`] trait in scope:
10//! ```rust
11//! use std::borrow::Cow;
12//! use std::str::FromStr;
13//! use packageurl::PackageUrl;
14//!
15//! let purl = PackageUrl::from_str("pkg:npm/%40angular/animation@12.3.1").unwrap();
16//! assert_eq!(purl.name(), "animation");
17//! assert_eq!(purl.namespace(), Some("@angular"));
18//! ```
19//!
20//! Parsing a purl may fail, in which case an error kind from the [`errors`] module
21//! is returned:
22//! ```rust
23//! use std::str::FromStr;
24//! use packageurl::PackageUrl;
25//!
26//! let err = PackageUrl::from_str("package@0.1.0").unwrap_err();
27//! assert_eq!(err, packageurl::Error::MissingScheme);
28//! ```
29//!
30//! The parsed [`PackageUrl`] will have a [`'static`] lifetime, so that the
31//! parsed string can be safely discarded.
32//!
33//! [`FromStr`]: https://doc.rust-lang.org/std/str/trait.FromStr.html
34//! [`PackageUrl`]: example_generated/struct.PackageUrl.html
35//! [`'static`]: https://doc.rust-lang.org/reference/items/static-items.html#static-lifetime-elision
36#![doc(issue_tracker_base_url = "https://github.com/althonos/packageurl.rs/issues/")]
37
38mod errors;
39mod parser;
40mod purl;
41mod utils;
42mod validation;
43
44pub use errors::Error;
45pub use errors::Result;
46pub use purl::PackageUrl;