Struct conjure_object::ResourceIdentifier

pub struct ResourceIdentifier { /* fields omitted */ }

A common format for wrapping existing unique identifiers to provide additional context.

Resource identifiers contain 4 components, prefixed by a format identifier ri, and separated with periods: ri.<service>.<instance>.<type>.<locator>.

• Service: The service or application that namespaces the rest of the identifier. Must conform to the regex pattern [a-z][a-z0-9\-]*.
• Instance: An optionally empty string that represents the specific service cluster, to allow for disambiduation of artifacts from different service clusters. Must conform to the regex pattern ([a-z0-9][a-z0-9\-]*)?.
• Type: A service-specific resource type to namespace a group of locators. Must conform to the regex pattern [a-z][a-z0-9\-\._]+.
• Locator: A string used to uniquely locate the specific resource. Must conform to the regex pattern [a-zA-Z0-9\-\._]+.

Methods

impl ResourceIdentifier

pub fn new(s: &str) -> Result<ResourceIdentifier, ParseError>

Creates a resource identifier from a string.

This function behaves identically to ResourceIdentifier's FromStr implementation.

pub fn from_components(
    service: &str,
    instance: &str,
    type_: &str,
    locator: &str
) -> Result<ResourceIdentifier, ParseError>

Creates a resource identifier from its individual components.

pub fn service(&self) -> &str

Returns the service component of the resource identifier.

pub fn instance(&self) -> &str

Returns the instance component of the resource identifier.

pub fn type_(&self) -> &str

Returns the type component of the resource identifier.

pub fn locator(&self) -> &str

Returns the locator component of the resource identifier.

pub fn as_str(&self) -> &str

Returns the string representation of the resource identifier.

pub fn into_string(self) -> String

Consumes the resource identifier, returning its owned string representation.

Trait Implementations

impl Plain for ResourceIdentifier

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats this value in its Conjure PLAIN format.

impl FromPlain for ResourceIdentifier

type Err = <ResourceIdentifier as FromStr>::Err

The error type returned when parsing fails.

fn from_plain(s: &str) -> Result<Self, Self::Err>

Parse a value from its Conjure PLAIN string representation.

impl PartialEq<ResourceIdentifier> for ResourceIdentifier

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

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

#[must_use]

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

This method tests for !=.

impl AsRef<str> for ResourceIdentifier

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for ResourceIdentifier

fn clone(&self) -> ResourceIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for ResourceIdentifier

fn cmp(&self, other: &ResourceIdentifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for ResourceIdentifier

impl PartialOrd<ResourceIdentifier> for ResourceIdentifier

fn partial_cmp(&self, other: &ResourceIdentifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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

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

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

fn lt(&self, other: &ResourceIdentifier) -> bool

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

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

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

impl Debug for ResourceIdentifier

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for ResourceIdentifier

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl FromStr for ResourceIdentifier

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ResourceIdentifier, ParseError>

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

impl Hash for ResourceIdentifier

fn hash<H>(&self, hasher: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Borrow<str> for ResourceIdentifier

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Serialize for ResourceIdentifier

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ResourceIdentifier

fn deserialize<D>(d: D) -> Result<ResourceIdentifier, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.