Enum proto_pdk_api::UnresolvedVersionSpec

pub enum UnresolvedVersionSpec {
    Canary,
    Alias(String),
    Req(VersionReq),
    ReqAny(Vec<VersionReq>),
    Version(Version),
}

Represents an unresolved version or alias that must be resolved to a fully-qualified and semantic result.

Variants

Canary

A special canary target.

Alias(String)

An alias that is used as a map to a version.

Req(VersionReq)

A partial version, requirement, or range (^, ~, etc).

ReqAny(Vec<VersionReq>)

A list of requirements to match any against (joined by ||).

Version(Version)

A fully-qualified semantic version.

Implementations

impl UnresolvedVersionSpec

pub fn parse<T>(value: T) -> Result<UnresolvedVersionSpec, Error>

where T: AsRef<str>,

Parse the provided string into an unresolved specification based on the following rules, in order:

• If the value “canary”, map as Canary variant.
• If an alpha-numeric value that starts with a character, map as Alias.
• If contains ||, split and parse each item with VersionReq, and map as ReqAny.
• If contains , or (space), parse with VersionReq, and map as Req.
• If starts with =, ^, ~, >, <, or *, parse with VersionReq, and map as Req.
• Else parse with Version, and map as Version.

pub fn is_alias<A>(&self, name: A) -> bool

where A: AsRef<str>,

Return true if the provided alias matches the current specification.

pub fn is_canary(&self) -> bool

Return true if the current specification is canary.

pub fn is_latest(&self) -> bool

Return true if the current specification is the “latest” alias.

pub fn to_resolved_spec(&self) -> VersionSpec

Convert the current unresolved specification to a resolved specification. Note that this does not actually resolve or validate against a manifest, and instead simply constructs the VersionSpec.

Furthermore, the Req and ReqAny variants will panic, as they are not resolved or valid versions.

Trait Implementations

impl AsRef<UnresolvedVersionSpec> for UnresolvedVersionSpec

fn as_ref(&self) -> &UnresolvedVersionSpec

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

impl Clone for UnresolvedVersionSpec

fn clone(&self) -> UnresolvedVersionSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnresolvedVersionSpec

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

Formats the value using the given formatter.

impl Default for UnresolvedVersionSpec

fn default() -> UnresolvedVersionSpec

Returns a latest alias.

impl<'de> Deserialize<'de> for UnresolvedVersionSpec

fn deserialize<__D>( __deserializer: __D ) -> Result<UnresolvedVersionSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnresolvedVersionSpec

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

Formats the value using the given formatter.

impl FromStr for UnresolvedVersionSpec

type Err = Error

The associated error which can be returned from parsing.

fn from_str( value: &str ) -> Result<UnresolvedVersionSpec, <UnresolvedVersionSpec as FromStr>::Err>

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

impl Hash for UnresolvedVersionSpec

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Into<String> for UnresolvedVersionSpec

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl PartialEq<VersionSpec> for UnresolvedVersionSpec

fn eq(&self, other: &VersionSpec) -> 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 PartialEq for UnresolvedVersionSpec

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

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 TryFrom<String> for UnresolvedVersionSpec

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: String ) -> Result<UnresolvedVersionSpec, <UnresolvedVersionSpec as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for UnresolvedVersionSpec

impl StructuralPartialEq for UnresolvedVersionSpec