Struct ShapeId 

pub struct ShapeId { /* private fields */ }

A Smithy Shape ID.

Shape IDs uniquely identify shapes in a Smithy model.

• fqn is "smithy.example#Foo"
• namespace is "smithy.example"
• shape_name is "Foo"

Implementations

impl ShapeId

pub const fn from_static( fqn: &'static str, namespace: &'static str, shape_name: &'static str, ) -> Self

Creates a ShapeId from a static string at compile time.

This is used for const initialization of prelude schemas.

pub fn new_from_parts( namespace: impl Into<Cow<'static, str>>, shape_name: impl Into<Cow<'static, str>>, ) -> Self

Creates a new ShapeId from a namespace and a shape_name.

Examples

use aws_smithy_schema::ShapeId;

let shape_id = ShapeId::new("smithy.api#String");

pub fn new_from_fqn(fqn: impl Into<Cow<'static, str>>) -> Option<Self>

Creates a new ShapeId from a fully qualified name.

pub fn new(fqn: impl Into<Cow<'static, str>>) -> Self

Creates a new ShapeId from a fully qualified name.

pub fn as_str(&self) -> &str

Returns the string representation of this ShapeId.

pub fn namespace(&self) -> &str

Returns the namespace portion of the ShapeId.

Examples

use aws_smithy_schema::ShapeId;

let shape_id = ShapeId::new("smithy.api#String");
assert_eq!(shape_id.namespace(), "smithy.api");

pub fn shape_name(&self) -> &str

Returns the shape name portion of the ShapeId.

Examples

use aws_smithy_schema::ShapeId;

let shape_id = ShapeId::new("smithy.api#String");
assert_eq!(shape_id.shape_name(), "String");

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

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

Examples

use aws_smithy_schema::ShapeId;

let shape_id = ShapeId::new("com.example#MyStruct$member");
assert_eq!(shape_id.member_name(), Some("member"));

Trait Implementations

impl Clone for ShapeId

fn clone(&self) -> ShapeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeId

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

Formats the value using the given formatter.

impl From<&str> for ShapeId

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for ShapeId

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for ShapeId

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

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

impl StructuralPartialEq for ShapeId