Struct fluvio_index::PackageId

pub struct PackageId<V = MaybeVersion> { /* fields omitted */ }

A unique identifier for a package that describes its registry, group, name, and (possibly) version.

There are two different variations of a PackageId, which have different formatting and parsing rules.

1. A PackageId<WithVersion> represents a fully-qualified package name that also refers to a specific version of the package. It is rendered (and parsed) as a string in the following form:

<registry>/<group>/<name>:<version>
OR
<group>/<name>:<version>
OR
<name>:<version>

Note that a PackageId<WithVersion> has strong guarantees on its FromStr implementation (and therefore, it’s parse() rules). This means that a PackageId<WithVersion> is guaranteed to have a version embedded in it, which can be accessed via .version().

2. A PackageId (i.e. PackageId<MaybeVersion>) might or might not contain a version, and will parse a package string that does OR does not have a version in it. This is the type you should use if you don’t need a version or if you want to do something different based on whether or not a version is given. An example of this might be installing a specific version of a package if a version is given, or defaulting to the latest version if not given.

Valid forms that will parse into a PackageId include:

<registry>/<group>/<name>
<group>/<name>
<name>
<registry>/<group>/<name>:<version>
<group>/<name>:<version>
<name>:<version>

Implementations

impl<T> PackageId<T>

pub fn registry(&self) -> &Registry

Return the registry of the package specified by this identifier

pub fn group(&self) -> &GroupName

Return the group of the package specified by this identifier

pub fn name(&self) -> &PackageName

Return the name of the package specified by this identifier

pub fn pretty(&self) -> impl Display

A printable representation of this PackageId

This displays the most concise representation of this PackageId that is still unique. For example, if the registry and group name are default values, this will display only the package name. If the group name is non-standard, it will be printed. If the registry is non-standard, both the registry and the group name will be printed.

pub fn uid(&self) -> String

A unique representation of this package, excluding version.

This is intended to be used for comparing two PackageId’s to see whether they refer to the same package entity, regardless of version.

Exmaple

let pid1: PackageId<MaybeVersion> = "fluvio/fluvio".parse().unwrap();
let pid2: PackageId<WithVersion> = "https://packages.fluvio.io/v1/fluvio/fluvio:1.2.3".parse().unwrap();
assert_eq!(pid1.uid(), pid2.uid());

impl PackageId<WithVersion>

pub fn new_versioned(
    name: PackageName,
    group: GroupName,
    version: Version
) -> Self

Create a new, versioned PackageId.

pub fn version(&self) -> &Version

A PackageId indisputably has a version, no Option required.

impl PackageId<MaybeVersion>

pub fn new_unversioned(name: PackageName, group: GroupName) -> Self

Create a new PackageId with no version info.

pub fn into_versioned(self, version: Version) -> PackageId<WithVersion>

Add a Version to any PackageId to create a PackageId

impl PackageId<MaybeVersion>

pub fn maybe_version(&self) -> Option<&Version>

Trait Implementations

impl<V: Clone> Clone for PackageId<V>

fn clone(&self) -> PackageId<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for PackageId<V>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageId<WithVersion>

fn deserialize<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for PackageId<MaybeVersion>

fn deserialize<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for PackageId<WithVersion>

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

Formats the value using the given formatter.

impl Display for PackageId<MaybeVersion>

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

Formats the value using the given formatter.

impl FromStr for PackageId<WithVersion>

type Err = Error

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 FromStr for PackageId<MaybeVersion>

type Err = Error

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<V: PartialEq> PartialEq<PackageId<V>> for PackageId<V>

fn eq(&self, other: &PackageId<V>) -> bool

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

fn ne(&self, other: &PackageId<V>) -> bool

This method tests for !=.

impl Serialize for PackageId<WithVersion>

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Serialize for PackageId<MaybeVersion>

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<V> StructuralPartialEq for PackageId<V>