Struct PkgName 

pub struct PkgName { /* private fields */ }

Parse a PKGNAME into its constituent parts.

In pkgsrc terminology a PKGNAME is made up of three parts:

• PKGBASE contains the name of the package
• PKGVERSION contains the full version string
• PKGREVISION is an optional package revision denoted by nb followed by a number.

The name and version are split at the last -, and the revision, if specified, should be located at the end of the version.

This module does not enforce strict formatting. If a PKGNAME is not well formed then values may be empty or None.

Examples

use pkgsrc::PkgName;

// A well formed package name.
let pkg = PkgName::new("mktool-1.3.2nb2");
assert_eq!(pkg.pkgname(), "mktool-1.3.2nb2");
assert_eq!(pkg.pkgbase(), "mktool");
assert_eq!(pkg.pkgversion(), "1.3.2nb2");
assert_eq!(pkg.pkgrevision(), Some(2));

// An invalid PKGREVISION that can likely only be created by accident.
let pkg = PkgName::new("mktool-1.3.2nb");
assert_eq!(pkg.pkgbase(), "mktool");
assert_eq!(pkg.pkgversion(), "1.3.2nb");
assert_eq!(pkg.pkgrevision(), Some(0));

// A "-" in the version causes an incorrect split.
let pkg = PkgName::new("mktool-1.3-2");
assert_eq!(pkg.pkgbase(), "mktool-1.3");
assert_eq!(pkg.pkgversion(), "2");
assert_eq!(pkg.pkgrevision(), None);

// Not well formed, but still accepted.
let pkg = PkgName::new("mktool");
assert_eq!(pkg.pkgbase(), "mktool");
assert_eq!(pkg.pkgversion(), "");
assert_eq!(pkg.pkgrevision(), None);

// Doesn't make any sense, but whatever!
let pkg = PkgName::new("1.0nb2");
assert_eq!(pkg.pkgbase(), "1.0nb2");
assert_eq!(pkg.pkgversion(), "");
assert_eq!(pkg.pkgrevision(), None);

Implementations

impl PkgName

pub fn new(pkgname: &str) -> Self

Create a new PkgName from a str reference.

pub fn pkgname(&self) -> &str

Return a str reference containing the original PKGNAME used to create this instance.

pub fn pkgbase(&self) -> &str

Return a str reference containing the PKGBASE portion of the package name, i.e. everything up to the final - and the version number.

pub fn pkgversion(&self) -> &str

Return a str reference containing the full PKGVERSION of the package name, i.e. everything after the final -. If no - was found in the str used to create this PkgName then this will be an empty string.

pub const fn pkgrevision(&self) -> Option<i64>

Return an optional PKGREVISION, i.e. the nb<x> suffix that denotes a pkgsrc revision. If any characters after the nb cannot be parsed as an i64 then None is returned. If there are no characters at all after the nb then Some(0) is returned.

Trait Implementations

impl Clone for PkgName

fn clone(&self) -> PkgName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PkgName

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

Formats the value using the given formatter.

impl Default for PkgName

fn default() -> PkgName

Returns the “default value” for a type.

impl Display for PkgName

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

Formats the value using the given formatter.

impl From<&String> for PkgName

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&str> for PkgName

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for PkgName

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromKv for PkgName

fn from_kv(value: &str, _span: Span) -> Result<Self>

Parse a value from a string.

impl FromStr for PkgName

type Err = Infallible

The associated error which can be returned from parsing.

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

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

impl Hash for PkgName

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 PkgName

fn cmp(&self, other: &PkgName) -> 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<&str> for PkgName

fn eq(&self, other: &&str) -> 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 PartialEq<String> for PkgName

fn eq(&self, other: &String) -> 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 PartialEq<str> for PkgName

fn eq(&self, other: &str) -> 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 PartialEq for PkgName

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

fn partial_cmp(&self, other: &PkgName) -> 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 PkgName

impl StructuralPartialEq for PkgName