Struct rustc_middle::ty::adt::AdtDef[][src]

pub struct AdtDef {
    pub did: DefId,
    pub variants: IndexVec<VariantIdx, VariantDef>,
    flags: AdtFlags,
    pub repr: ReprOptions,
}
Expand description

The definition of a user-defined type, e.g., a struct, enum, or union.

These are all interned (by alloc_adt_def) into the global arena.

The initialism ADT stands for an algebraic data type (ADT). This is slightly wrong because unions are not ADTs. Moreover, Rust only allows recursive data types through indirection.

Fields

did: DefId

The DefId of the struct, enum or union item.

variants: IndexVec<VariantIdx, VariantDef>

Variants of the ADT. If this is a struct or union, then there will be a single variant.

flags: AdtFlags

Flags of the ADT (e.g., is this a struct? is this non-exhaustive?).

repr: ReprOptions

Repr options provided by the user.

Implementations

Calculates the forest of DefIds from which this ADT is visibly uninhabited.

Creates a new AdtDef.

Returns true if this is a struct.

Returns true if this is a union.

Returns true if this is an enum.

Returns true if the variant list of this ADT is #[non_exhaustive].

Returns the kind of the ADT.

Returns a description of this abstract data type.

Returns a description of a variant of this abstract data type.

If this function returns true, it implies that is_struct must return true.

Returns true if this type is #[fundamental] for the purposes of coherence checking.

Returns true if this is PhantomData<T>.

Returns true if this is Box.

Returns true if this is ManuallyDrop<T>.

Returns true if this type has a destructor.

Asserts this is a struct or union and returns its unique variant.

Returns an iterator over all fields contained by this ADT.

Whether the ADT lacks fields. Note that this includes uninhabited enums, e.g., enum Void {} is considered payload free as well.

Return a VariantDef given a variant id.

Return a VariantDef given a constructor id.

Return the index of VariantDef given a variant id.

Return the index of VariantDef given a constructor id.

Computes the discriminant value used by a specific variant. Unlike discriminants, this is (amortized) constant-time, only doing at most one query for evaluating an explicit discriminant (the last one before the requested variant), assuming there are no constant-evaluation errors there.

Yields a DefId for the discriminant and an offset to add to it Alternatively, if there is no explicit discriminant, returns the inferred discriminant directly.

Returns a list of types such that Self: Sized if and only if that type is Sized, or TyErr if this type is recursive.

Oddly enough, checking that the sized-constraint is Sized is actually more expressive than checking all members: the Sized trait is inductive, so an associated type that references Self would prevent its containing ADT from being Sized.

Due to normalization being eager, this applies even if the associated type is behind a pointer (e.g., issue #31299).

Trait Implementations

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

There should be only one AdtDef for each did, therefore it is fine to implement Ord only based on did.

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

AdtDefs are basically the same as a DefId.

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free. Read more

Returns true if this self has any regions that escape binder (and hence are not bound by it). Read more

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound. Read more

True if there are any un-erased free regions.

Indicates whether this value definitely references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching. Read more

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching. Read more

True if there are any late-bound regions

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes