Struct VersionIdent 

pub struct VersionIdent { /* private fields */ }

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

This struct can be created in a number of ways:

use thunderstore::VersionIdent;

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

Methods on crate::Client accept any type that implements IntoVersionIdent, 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 VersionIdent

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

Creates a new VersionIdent.

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

Examples

use thunderstore::VersionIdent;

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

pub fn namespace(&self) -> &str

The namespace/owner of the package.

Examples

use thunderstore::VersionIdent;

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

pub fn name(&self) -> &str

The name of the package.

Examples

use thunderstore::VersionIdent;

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

pub fn version(&self) -> &str

The version number of the package.

Examples

use thunderstore::VersionIdent;

let ident: VersionIdent = "BepInEx-BepInExPack-5.4.2100".parse().unwrap();
assert_eq!(ident.version(), "5.4.2100");

pub fn parsed_version(&self) -> Version

The version number of the package as a semver::Version

Examples

use thunderstore::VersionIdent;

let ident: VersionIdent = "BepInEx-BepInExPack-5.4.2100".parse().unwrap();

let version = ident.parsed_version();
assert_eq!(version.major, 5);
assert_eq!(version.minor, 4);
assert_eq!(version.patch, 2100);

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

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

Example

use thunderstore::VersionIdent;

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

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

Unwraps the underlying string, formatted as namespace-name-version.

pub fn into_string(self) -> String

Unwraps the underlying string, formatted as namespace-name-version.

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

pub fn as_str(&self) -> &str

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

pub fn package_id(&self) -> PackageIdent

Returns a copy of the identifier with the version removed.

Trait Implementations

impl AsRef<str> for VersionIdent

fn as_ref(&self) -> &str

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

impl Clone for VersionIdent

fn clone(&self) -> VersionIdent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionIdent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionIdent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VersionIdent

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, V> From<(T, U, V)> for VersionIdent

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

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

Converts to this type from the input type.

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

fn from(id: VersionIdent) -> Self

Converts to this type from the input type.

impl From<VersionIdent> for String

fn from(id: VersionIdent) -> Self

Converts to this type from the input type.

impl FromStr for VersionIdent

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 VersionIdent

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> IntoVersionIdent<'a> for &'a VersionIdent

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

impl Ord for VersionIdent

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 VersionIdent

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 VersionIdent

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 VersionIdent

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 VersionIdent

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 VersionIdent

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 VersionIdent

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 VersionIdent