Struct ResourceKey 

pub struct ResourceKey { /* private fields */ }

Stable identity for a desired external resource.

Implementations

impl ResourceKey

pub fn new(key: impl Into<Box<str>>) -> Self

Creates a single-segment resource key from deterministic host-chosen identity.

pub fn from_segments<I, S>(segments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<Box<str>>,

Creates a resource key from ordered identity segments.

Prefer this for product identifiers with multiple parts. Hosts can recover the exact segments from close commands without parsing a flattened string.

Panics

Panics when called with no segments. Use Self::try_from_segments when the segment list may be empty.

pub fn try_from_segments<I, S>(segments: I) -> Option<Self>

where I: IntoIterator<Item = S>, S: Into<Box<str>>,

Creates a resource key from ordered identity segments, returning None when the segment list is empty.

pub fn wildcard(key: impl AsRef<str>) -> Self

Creates an explicit broad-resource key.

Core treats this as an opaque identity; tests and applications decide whether the key represents a forbidden fallback or wildcard resource.

pub fn as_str(&self) -> &str

Returns this key’s deterministic encoded representation.

Use Self::segments or Self::segment when application code needs product identity back from a resource command. Single-segment keys return the segment directly unless it is in core’s reserved diagnostic namespace.

pub fn segments(&self) -> impl ExactSizeIterator<Item = &str> + '_

Returns this key’s ordered identity segments.

pub fn segment(&self, index: usize) -> Option<&str>

Returns one identity segment by index.

pub fn segment_count(&self) -> usize

Returns the number of identity segments.

Trait Implementations

impl Clone for ResourceKey

fn clone(&self) -> ResourceKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceKey

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

Formats the value using the given formatter.

impl Eq for ResourceKey

impl Hash for ResourceKey

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 ResourceKey

fn cmp(&self, other: &ResourceKey) -> 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 ResourceKey

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

fn partial_cmp(&self, other: &ResourceKey) -> 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 StructuralPartialEq for ResourceKey