Struct ShapeId 

pub struct ShapeId<'a> { /* private fields */ }

A Smithy Shape ID, parameterized over the lifetime of its component strings.

ShapeId<'static> is the codegen-emitted form (zero-allocation, const-constructible via the shape_id! macro). ShapeId<'a> for shorter 'a is constructible from runtime-parsed bytes — for example, from a wire-format __type field on a JSON response.

Use the shape_id! macro to construct 'static instances — it computes the fully qualified name at compile time from the namespace and shape name, preventing the parts from getting out of sync.

Examples

use aws_smithy_schema::{shape_id, ShapeId};

const ID: ShapeId<'static> = shape_id!("smithy.api", "String");
assert_eq!(ID.namespace(), "smithy.api");
assert_eq!(ID.shape_name(), "String");
assert_eq!(ID.as_str(), "smithy.api#String");

Variance

ShapeId<'a> is covariant in 'a because every field is of the form &'a str. This means a ShapeId<'static> (codegen-emitted) is usable everywhere a ShapeId<'a> is expected, regardless of 'a.

Equality, hashing, and borrow

Two ShapeIds compare equal when their fully qualified names (Self::as_str) compare equal. The other fields are determined by the FQN for any ShapeId constructed via the shape_id! macro or Self::from_parts with consistent parts, so this is the same equality you would get from comparing every field.

FQN-based equality lets ShapeId act as Borrow<str>: a HashMap<ShapeId<'static>, V> can be looked up by &str (or by any &ShapeId<'_> via Self::as_str) without going through the 'static-bound storage key. This is what the cross-lifetime lookup APIs on TypeRegistry and TraitMap rely on.

Implementations

impl<'a> ShapeId<'a>

pub const fn as_str(&self) -> &'a str

Returns the fully qualified string representation (e.g. "smithy.api#String").

The return type is &'a str (the lifetime of the data, not the receiver). Calling this on ShapeId<'static> yields &'static str, preserving the codegen-side 'static accessor guarantee.

pub const fn namespace(&self) -> &'a str

Returns the namespace portion of the ShapeId.

Lifetime is 'a — see Self::as_str for rationale.

pub const fn shape_name(&self) -> &'a str

Returns the shape name portion of the ShapeId.

Lifetime is 'a — see Self::as_str for rationale.

pub fn member_name(&self) -> Option<&'a str>

Returns the member name if this is a member shape ID.

Lifetime is 'a — see Self::as_str for rationale.

Trait Implementations

impl Borrow<str> for ShapeId<'_>

fn borrow(&self) -> &str

Borrows the fully qualified name. Combined with the FQN-based Hash/Eq impls, this lets HashMap<ShapeId<'static>, V>::get accept &str keys, enabling cross-lifetime lookup against a 'static-keyed table.

impl<'a> Clone for ShapeId<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ShapeId<'a>

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

Formats the value using the given formatter.

impl Display for ShapeId<'_>

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

Formats the value using the given formatter.

impl Eq for ShapeId<'_>

impl Hash for ShapeId<'_>

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

Hashes the fully qualified name so that hash(id) agrees with hash(id.as_str()) — required for the Borrow<str> impl.

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 PartialEq for ShapeId<'_>

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

Two ShapeIds are equal iff their fully qualified names match. See the type-level docs for why this is sound.

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

Inequality operator !=.