Struct TypeDecl

pub struct TypeDecl {
    pub def_id: TypeDeclId,
    pub item_meta: ItemMeta,
    pub generics: GenericParams,
    pub src: ItemSource,
    pub kind: TypeDeclKind,
    pub layout: Option<Layout>,
    pub ptr_metadata: PtrMetadata,
    pub repr: Option<ReprOptions>,
}

A type declaration.

Types can be opaque or transparent.

Transparent types are local types not marked as opaque. Opaque types are the others: local types marked as opaque, and non-local types (coming from external dependencies).

In case the type is transparent, the declaration also contains the type definition (see TypeDeclKind).

A type can only be an ADT (structure or enumeration), as type aliases are inlined in MIR.

Fields

def_id: TypeDeclId

item_meta: ItemMeta

Meta information associated with the item.

generics: GenericParams

src: ItemSource

The context of the type: distinguishes top-level items from closure-related items.

kind: TypeDeclKind

The type kind: enum, struct, or opaque.

layout: Option<Layout>

The layout of the type. Information may be partial because of generics or dynamically- sized types. If rustc cannot compute a layout, it is None.

ptr_metadata: PtrMetadata

The metadata associated with a pointer to the type.

repr: Option<ReprOptions>

The representation options of this type declaration as annotated by the user. Is None for foreign type declarations.

Implementations

impl TypeDecl

pub fn get_variant_from_tag(&self, tag: ScalarValue) -> Option<VariantId>

Looks up the variant corresponding to the tag (i.e. the in-memory bytes that represent the discriminant). Returns None for types that don’t have a relevant discriminant (e.g. uninhabited types).

If the tag does not correspond to any valid discriminant but there is a niche, the resulting VariantId will be for the untagged variant TagEncoding::Niche::untagged_variant.

pub fn is_c_repr(&self) -> bool

pub fn get_field_by_name( &self, variant: Option<VariantId>, field_name: &str, ) -> Option<(FieldId, &Field)>

Trait Implementations

impl AstVisitable for TypeDecl

fn drive<V: VisitAst>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_mut<V: VisitAstMut>(&mut self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn name(&self) -> &'static str

The name of the type, used for debug logging.

fn dyn_visit<T: AstVisitable>(&self, f: impl FnMut(&T))

Visit all occurrences of that type inside self, in pre-order traversal.

fn dyn_visit_mut<T: AstVisitable>(&mut self, f: impl FnMut(&mut T))

Visit all occurrences of that type inside self, in pre-order traversal.

impl Clone for TypeDecl

fn clone(&self) -> TypeDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeDecl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TypeDecl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'s, V> Drive<'s, V> for TypeDecl

where V: Visitor + Visit<'s, ItemMeta> + Visit<'s, GenericParams> + Visit<'s, ItemSource> + Visit<'s, TypeDeclKind> + Visit<'s, Option<Layout>> + Visit<'s, PtrMetadata>,

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveMut<'s, V> for TypeDecl

where V: Visitor + VisitMut<'s, ItemMeta> + VisitMut<'s, GenericParams> + VisitMut<'s, ItemSource> + VisitMut<'s, TypeDeclKind> + VisitMut<'s, Option<Layout>> + VisitMut<'s, PtrMetadata>,

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<C: AstFormatter> FmtWithCtx<C> for TypeDecl

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

fn with_ctx<'a>(&'a self, ctx: &'a C) -> WithCtx<'a, C, Self>

Returns a struct that implements Display. This allows the following:

fn to_string_with_ctx(&self, ctx: &C) -> String

impl Serialize for TypeDecl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.