Enum TypeInfo

pub enum TypeInfo {
    Struct(StructInfo),
    TupleStruct(TupleStructInfo),
    Tuple(TupleInfo),
    List(ListInfo),
    Array(ArrayInfo),
    Map(MapInfo),
    Set(SetInfo),
    Enum(EnumInfo),
    Opaque(OpaqueInfo),
}

Compile-time type information for various reflected types.

Generally, for any given type, this value can be retrieved in one of four ways:

1. Typed::type_info
2. DynamicTyped::reflect_type_info
3. PartialReflect::get_represented_type_info
4. TypeRegistry::get_type_info

Each return a static reference to TypeInfo, but they all have their own use cases. For example, if you know the type at compile time, Typed::type_info is probably the simplest. If you have a dyn Reflect you can use DynamicTyped::reflect_type_info. If all you have is a dyn PartialReflect, you’ll probably want PartialReflect::get_represented_type_info. Lastly, if all you have is a TypeId or type path, you will need to go through TypeRegistry::get_type_info.

You may also opt to use TypeRegistry::get_type_info in place of the other methods simply because it can be more performant. This is because those other methods may require attaining a lock on the static TypeInfo, while the registry simply checks a map.

Variants

Struct(StructInfo)

TupleStruct(TupleStructInfo)

Tuple(TupleInfo)

List(ListInfo)

Array(ArrayInfo)

Map(MapInfo)

Set(SetInfo)

Enum(EnumInfo)

Opaque(OpaqueInfo)

Implementations

impl TypeInfo

pub fn ty(&self) -> &Type

The underlying Rust type.

pub fn type_id(&self) -> TypeId

The TypeId of the underlying type.

pub fn type_path_table(&self) -> &TypePathTable

A representation of the type path of the underlying type.

Provides dynamic access to all methods on TypePath.

pub fn type_path(&self) -> &'static str

The stable, full type path of the underlying type.

Use type_path_table if you need access to the other methods on TypePath.

pub fn is<T: Any>(&self) -> bool

Check if the given type matches this one.

This only compares the TypeId of the types and does not verify they share the same TypePath (though it implies they do).

pub fn kind(&self) -> ReflectKind

Returns the kind of this TypeInfo.

pub fn generics(&self) -> &Generics

Gets the generic parameters for this type.

impl TypeInfo

Conversion convenience methods for TypeInfo.

pub fn as_struct(&self) -> Result<&StructInfo, TypeInfoError>

Attempts a cast to StructInfo.

Returns an error if self is not TypeInfo::Struct.

pub fn as_tuple_struct(&self) -> Result<&TupleStructInfo, TypeInfoError>

Attempts a cast to TupleStructInfo.

Returns an error if self is not TypeInfo::TupleStruct.

pub fn as_tuple(&self) -> Result<&TupleInfo, TypeInfoError>

Attempts a cast to TupleInfo.

Returns an error if self is not TypeInfo::Tuple.

pub fn as_list(&self) -> Result<&ListInfo, TypeInfoError>

Attempts a cast to ListInfo.

Returns an error if self is not TypeInfo::List.

pub fn as_array(&self) -> Result<&ArrayInfo, TypeInfoError>

Attempts a cast to ArrayInfo.

Returns an error if self is not TypeInfo::Array.

pub fn as_map(&self) -> Result<&MapInfo, TypeInfoError>

Attempts a cast to MapInfo.

Returns an error if self is not TypeInfo::Map.

pub fn as_enum(&self) -> Result<&EnumInfo, TypeInfoError>

Attempts a cast to EnumInfo.

Returns an error if self is not TypeInfo::Enum.

pub fn as_opaque(&self) -> Result<&OpaqueInfo, TypeInfoError>

Attempts a cast to OpaqueInfo.

Returns an error if self is not TypeInfo::Opaque.

Trait Implementations

impl Clone for TypeInfo

fn clone(&self) -> TypeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypeInfo

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

Formats the value using the given formatter.

impl TypedProperty for TypeInfo

type Stored = TypeInfo