Struct PackageIdent

pub struct PackageIdent { /* private fields */ }

A unique identifier for a package, formatted as namespace-name.

This struct can be created in a number of ways:

use thunderstore::PackageIdent;

let a = PackageIdent::new("BepInEx", "BepInExPack");
let b: PackageIdent = "BepInEx-BepInExPack".parse().unwrap();
let c: PackageIdent = ("BepInEx", "BepInExPack").into();

Methods on crate::Client accept any type that implements IntoPackageIdent, which allows any of the above methods to be used interchangeably.

The underlying string is either an owned String or a string literal (&'static str).

Implementations

impl PackageIdent

pub fn new(namespace: impl AsRef<str>, name: impl AsRef<str>) -> Self

Creates a new PackageIdent.

This copies the arguments into a newly allocated String, delimited by -.

Examples

use thunderstore::PackageIdent;

let ident = PackageIdent::new("BepInEx", "BepInExPack");
assert_eq!(ident.into_string(), "BepInEx-BepInExPack");

pub fn namespace(&self) -> &str

The namespace/owner of the package.

Examples

use thunderstore::PackageIdent;

let ident: PackageIdent = "BepInEx-BepInExPack".parse().unwrap();
assert_eq!(ident.namespace(), "BepInEx");

pub fn name(&self) -> &str

The name of the package.

Examples

use thunderstore::PackageIdent;

let ident: PackageIdent = "BepInEx-BepInExPack".parse().unwrap();
assert_eq!(ident.name(), "BepInExPack");

pub fn path(&self) -> impl Display + '_

Returns an object that, when formatted with {}, will produce the URL path for this package.

Examples

use thunderstore::PackageIdent;

let ident = PackageIdent::new("BepInEx", "BepInExPack");
assert_eq!(ident.path().to_string(), "BepInEx/BepInExPack");

pub fn into_cow(self) -> Cow<'static, str>

Unwraps the underlying string, formatted as namespace-name.

pub fn into_string(self) -> String

Unwraps the underlying string, formatted as namespace-name.

If the string is a 'static str, it is converted to an owned String. If you don’t want that, see PackageIdent::into_cow.

pub fn as_str(&self) -> &str

Returns a reference to the underlying string, formatted as namespace-name.

pub fn with_version(&self, version: impl AsRef<str>) -> VersionIdent

Creates a copy of the identifier with a specific version.

Trait Implementations

impl AsRef<str> for PackageIdent

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PackageIdent

fn clone(&self) -> PackageIdent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageIdent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageIdent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PackageIdent

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

Formats the value using the given formatter.

impl From<&VersionIdent> for PackageIdent

fn from(id: &VersionIdent) -> Self

Converts to this type from the input type.

impl<T, U> From<(T, U)> for PackageIdent

where T: AsRef<str>, U: AsRef<str>,

fn from((namespace, name): (T, U)) -> Self

Converts to this type from the input type.

impl From<PackageIdent> for Cow<'static, str>

fn from(id: PackageIdent) -> Self

Converts to this type from the input type.

impl From<PackageIdent> for String

fn from(id: PackageIdent) -> Self

Converts to this type from the input type.

impl FromStr for PackageIdent

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for PackageIdent

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<'a> IntoPackageIdent<'a> for &'a PackageIdent

fn into_id(self) -> Result<Cow<'a, PackageIdent>>

impl Ord for PackageIdent

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

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

fn partial_cmp(&self, other: &Self) -> 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 Serialize for PackageIdent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&'static str> for PackageIdent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'static str) -> Result<Self>

Performs the conversion.

impl TryFrom<Cow<'static, str>> for PackageIdent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Cow<'static, str>) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for PackageIdent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl Eq for PackageIdent