Struct PkgPath

pub struct PkgPath { /* private fields */ }

Handling for PKGPATH metadata and relative package directory locations.

PkgPath is a struct for storing the path to a package within pkgsrc.

Binary packages contain the PKGPATH metadata, for example pkgtools/pkg_install, while across pkgsrc dependencies are referred to by their relative location, for example ../../pkgtools/pkg_install.

PkgPath takes either format as input, validates it for correctness, then stores both internally as PathBuf entries.

Once stored, as_path returns the short path as a Path, while as_full_path returns the full relative path as a Path.

As PkgPath uses PathBuf under the hood, there is a small amount of normalisation performed, for example trailing or double slashes, but otherwise input strings are expected to be precisely formatted, and a PkgPathError is raised otherwise.

Examples

use pkgsrc::PkgPath;
use std::ffi::OsStr;

let p = PkgPath::new("pkgtools/pkg_install").unwrap();
assert_eq!(p.as_path(), OsStr::new("pkgtools/pkg_install"));
assert_eq!(p.as_full_path(), OsStr::new("../../pkgtools/pkg_install"));

let p = PkgPath::new("../../pkgtools/pkg_install").unwrap();
assert_eq!(p.as_path(), OsStr::new("pkgtools/pkg_install"));
assert_eq!(p.as_full_path(), OsStr::new("../../pkgtools/pkg_install"));

// Missing category path.
assert!(PkgPath::new("../../pkg_install").is_err());

// Must traverse back to the pkgsrc root directory.
assert!(PkgPath::new("../pkg_install").is_err());

// Not fully formed.
assert!(PkgPath::new("/pkgtools/pkg_install").is_err());;

Implementations

impl PkgPath

pub fn new(path: &str) -> Result<Self, PkgPathError>

Create a new PkgPath

pub fn as_path(&self) -> &Path

Return a Path reference containing the short version of a PkgPath, for example pkgtools/pkg_install.

pub fn as_full_path(&self) -> &Path

Return a Path reference containing the full version of a PkgPath, for example ../../pkgtools/pkg_install.

Trait Implementations

impl Clone for PkgPath

fn clone(&self) -> PkgPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PkgPath

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

Formats the value using the given formatter.

impl Default for PkgPath

fn default() -> PkgPath

Returns the “default value” for a type.

impl FromStr for PkgPath

type Err = PkgPathError

The associated error which can be returned from parsing.

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

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

impl Hash for PkgPath

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 Ord for PkgPath

fn cmp(&self, other: &PkgPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PkgPath

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

fn partial_cmp(&self, other: &PkgPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PkgPath

impl StructuralPartialEq for PkgPath