Struct thunderstore::PackageId

pub struct PackageId { /* private fields */ }

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

This struct can be created in a number of ways:

use thunderstore::PackageId;

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

Most methods on Client accept any type that implements IntoPackageId, which allows any of the above methods to be used interchangeably.

Implementations

impl PackageId

pub fn new(namespace: &str, name: &str) -> Self

pub fn namespace(&self) -> &str

pub fn name(&self) -> &str

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

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

Example

let id = thunderstore::PackageId::new("BepInEx", "BepInExPack");
assert_eq!(id.path().to_string(), "BepInEx/BepInExPack");

pub fn into_string(self) -> String

Consumes the PackageId and returns the underlying string, formatted as namespace-name.

pub fn as_str(&self) -> &str

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

Trait Implementations

impl AsRef<str> for PackageId

fn as_ref(&self) -> &str

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

impl Clone for PackageId

fn clone(&self) -> PackageId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageId

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

Formats the value using the given formatter.

impl Display for PackageId

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

Formats the value using the given formatter.

impl From<&PackageExperimental> for PackageId

fn from(pkg: &PackageExperimental) -> Self

Converts to this type from the input type.

impl From<&VersionId> for PackageId

fn from(id: &VersionId) -> Self

Converts to this type from the input type.

impl From<(&str, &str)> for PackageId

fn from((namespace, name): (&str, &str)) -> Self

Converts to this type from the input type.

impl From<PackageId> for String

fn from(id: PackageId) -> Self

Converts to this type from the input type.

impl FromStr for PackageId

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 PackageId

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 PackageId

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PackageId

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PackageId

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<String> for PackageId

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 PackageId