Struct DependencyName 

pub struct DependencyName { /* private fields */ }

A dependency name.

Dependency names begin with an ASCII letter and continue with ASCII letters, digits, underscores, or hyphens. Following Cargo’s convention, hyphens and underscores are interchangeable: spell-book and spell_book refer to the same dependency.

Two forms are stored: the manifest form preserves the exact spelling from module.json, and the identifier form replaces hyphens with underscores to produce a valid WDL identifier suitable for use in symbolic imports. The identifier form must not be a reserved keyword.

Eq, Ord, and Hash operate on the identifier form only, so spell-book and spell_book are the same key in maps and sets. This enforces the spec rule that hyphens and underscores are interchangeable for the purpose of identity. Use manifest() when exact-spelling fidelity is needed (e.g., serialization or display).

Implementations

impl DependencyName

pub fn manifest(&self) -> &str

Returns the name as written in module.json.

pub fn identifier(&self) -> &str

Returns the WDL identifier form of the name (hyphens replaced with underscores).

pub fn into_manifest(self) -> String

Consumes the DependencyName and returns the manifest form.

pub fn into_identifier(self) -> String

Consumes the DependencyName and returns the identifier form.

Trait Implementations

impl AsRef<str> for DependencyName

fn as_ref(&self) -> &str

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

impl Clone for DependencyName

fn clone(&self) -> DependencyName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DependencyName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DependencyName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DependencyName

impl From<DependencyName> for String

fn from(name: DependencyName) -> Self

Converts to this type from the input type.

impl FromStr for DependencyName

type Err = DependencyNameError

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 Hash for DependencyName

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 DependencyName

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 DependencyName

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 DependencyName

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 DependencyName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for DependencyName

type Error = DependencyNameError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.