Struct TypeKey 

pub struct TypeKey { /* private fields */ }

Canonical type-shape key: identity is the token string of the normalized type. Normalization is a closed rule set — group/paren unwrap, a crate::/self::/source-module path reduced to its final segment, and a prelude path read as the bare name the language knows it by (std::vec::Vec<Foo> ≡ Vec<Foo>) — and any spelling it does not cover is kept verbatim.

A key is an identity, and nothing else

It is what a table is indexed by. It is not a route to syn::Type: the only way to reach a type’s syntax is Conversions::reading (in the registry layer above) followed by TypeRef, because a reading is what pairs a spelling with the classification that vouches for it.

This used to keep the parsed form beside the string and hand it out through to_type(), which let any holder of a key produce tokens for a type the model never classified — the same capability #280 sealed TypeRef against, granted by the key itself. A caller that wants tokens now has to have gotten them from somewhere that knows what they mean: the registry’s reading, or the declaration that wrote them (#291).

What a key can still answer about itself is what it is called — Self::as_str, Self::ident, Self::short_name — because a name is not syntax.

Implementations

impl TypeKey

pub fn parse(s: &str) -> Result<TypeKey, TypeKeyParseError>

Build a key by parsing the input as a type and normalizing.

The parse is kept for validation and then discarded: a key that cannot be a type is a mistake worth reporting at the declaration, and a key that can is still only its canonical string.

pub fn from_type(ty: &Type) -> TypeKey

Build a key directly from a syn::Type (normalizing a clone; the input is not modified).

pub fn from_ident(ident: &Ident) -> TypeKey

Build a key for a bare item ident — infallible by construction (an ident IS a single-segment path type; nothing to parse or normalize).

pub fn as_str(&self) -> &str

The canonical string form.

pub fn ident(&self) -> Option<Ident>

The bare item ident this key names — Foo, a::Foo → Foo, a::Foo<u8>::Bar → Bar; None when the last segment carries generic arguments (Vec<u8> names no bare item) or the key is not a path. Matches bare_path_ident on the same type — a correspondence this crate’s tests pin.

A name is not syntax, which is why this is the key’s business and producing a syn::Type is not. A caller that wants to look a declared item up by name was never asking for tokens; it was asking the key what it is called (#291).

pub fn short_name(&self) -> Option<String>

The last path segment’s ident, ignoring its generic arguments — Publisher<'static> → "Publisher", a::Foo<u8>::Bar → "Bar". None for anything that is not a path.

The looser sibling of Self::ident, for the callers that derive a destination-language class name from a Rust type: a declaration writes ptr_class!(Publisher<'static>) and means the class Publisher.

Trait Implementations

impl Clone for TypeKey

fn clone(&self) -> TypeKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeKey

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

Formats the value using the given formatter.

impl Display for TypeKey

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

Formats the value using the given formatter.

impl Eq for TypeKey

impl Hash for TypeKey

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

where H: Hasher,

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 TypeKey

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TypeKey

fn partial_cmp(&self, other: &TypeKey) -> 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.