Struct PackageIdentifier

pub struct PackageIdentifier(/* private fields */);

Implementations

impl PackageIdentifier

pub const MAX_CHAR_LENGTH: usize = 128usize

pub const MIN_PARTS: usize = 2usize

pub const MAX_PARTS: usize = 8usize

pub const MAX_PART_CHAR_LENGTH: usize = 32usize

pub fn new<T: AsRef<str> + Into<CompactString>>( identifier: T, ) -> Result<Self, PackageIdentifierError>

Creates a new PackageIdentifier from any type that implements AsRef<str> and Into<CompactString>.

Errors

Will return Err if the package identifier:

1. Is empty
2. Has an empty part
3. Is more than 128 characters long
4. Has a part more than 32 characters long
5. Contains a disallowed character (control, whitespace, or one of DISALLOWED_CHARACTERS)

pub unsafe fn new_unchecked<T: Into<CompactString>>(identifier: T) -> Self

Creates a new PackageIdentifier from any type that implements Into<CompactString> without checking its validity.

Safety

The package identifier must not:

1. Be empty
2. Have an empty part
3. Be more than 128 characters long
4. Have a part more than 32 characters long
5. Contain a disallowed character (control, whitespace, or one of DISALLOWED_CHARACTERS)

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire PackageIdentifier.

Trait Implementations

impl Clone for PackageIdentifier

fn clone(&self) -> PackageIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageIdentifier

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

Formats the value using the given formatter.

impl Default for PackageIdentifier

fn default() -> PackageIdentifier

Returns the “default value” for a type.

impl Display for PackageIdentifier

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

Formats the value using the given formatter.

impl FromStr for PackageIdentifier

type Err = PackageIdentifierError

The associated error which can be returned from parsing.

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

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

impl Hash for PackageIdentifier

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 PackageIdentifier

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

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

fn partial_cmp(&self, other: &PackageIdentifier) -> 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 TryFrom<CompactString> for PackageIdentifier

type Error = PackageIdentifierError

The type returned in the event of a conversion error.

fn try_from(value: CompactString) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PackageIdentifier

impl StructuralPartialEq for PackageIdentifier