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

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

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

impl<'tcx> AdtDef[src]

fn uninhabited_from(
    &self,
    tcx: TyCtxt<'tcx>,
    substs: SubstsRef<'tcx>,
    param_env: ParamEnv<'tcx>
) -> DefIdForest
[src]

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

impl<'tcx> AdtDef[src]

pub(super) fn new(
    tcx: TyCtxt<'_>,
    did: DefId,
    kind: AdtKind,
    variants: IndexVec<VariantIdx, VariantDef>,
    repr: ReprOptions
) -> Self
[src]

Creates a new AdtDef.

pub fn is_struct(&self) -> bool[src]

Returns true if this is a struct.

pub fn is_union(&self) -> bool[src]

Returns true if this is a union.

pub fn is_enum(&self) -> bool[src]

Returns true if this is a enum.

pub fn is_variant_list_non_exhaustive(&self) -> bool[src]

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

pub fn adt_kind(&self) -> AdtKind[src]

Returns the kind of the ADT.

pub fn descr(&self) -> &'static str[src]

Returns a description of this abstract data type.

pub fn variant_descr(&self) -> &'static str[src]

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

pub fn has_ctor(&self) -> bool[src]

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

pub fn is_fundamental(&self) -> bool[src]

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

pub fn is_phantom_data(&self) -> bool[src]

Returns true if this is PhantomData<T>.

pub fn is_box(&self) -> bool[src]

Returns true if this is Box.

pub fn is_manually_drop(&self) -> bool[src]

Returns true if this is ManuallyDrop<T>.

pub fn has_dtor(&self, tcx: TyCtxt<'tcx>) -> bool[src]

Returns true if this type has a destructor.

pub fn non_enum_variant(&self) -> &VariantDef[src]

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

pub fn predicates(&self, tcx: TyCtxt<'tcx>) -> GenericPredicates<'tcx>[src]

pub fn all_fields(&self) -> impl Iterator<Item = &FieldDef> + Clone[src]

Returns an iterator over all fields contained by this ADT.

pub fn is_payloadfree(&self) -> bool[src]

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

pub fn variant_with_id(&self, vid: DefId) -> &VariantDef[src]

Return a VariantDef given a variant id.

pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef[src]

Return a VariantDef given a constructor id.

pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx[src]

Return the index of VariantDef given a variant id.

pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx[src]

Return the index of VariantDef given a constructor id.

pub fn variant_of_res(&self, res: Res) -> &VariantDef[src]

pub fn eval_explicit_discr(
    &self,
    tcx: TyCtxt<'tcx>,
    expr_did: DefId
) -> Option<Discr<'tcx>>
[src]

pub fn discriminants(
    &'tcx self,
    tcx: TyCtxt<'tcx>
) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx>
[src]

pub fn variant_range(&self) -> Range<VariantIdx>[src]

pub fn discriminant_for_variant(
    &self,
    tcx: TyCtxt<'tcx>,
    variant_index: VariantIdx
) -> Discr<'tcx>
[src]

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.

pub fn discriminant_def_for_variant(
    &self,
    variant_index: VariantIdx
) -> (Option<DefId>, u32)
[src]

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.

pub fn destructor(&self, tcx: TyCtxt<'tcx>) -> Option<Destructor>[src]

pub fn sized_constraint(&self, tcx: TyCtxt<'tcx>) -> &'tcx [Ty<'tcx>]

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

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

impl<'tcx> ArenaAllocatable<'tcx, AdtDef> for AdtDef[src]

fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut Self[src]

fn allocate_from_iter<'a>(
    arena: &'a Arena<'tcx>,
    iter: impl IntoIterator<Item = Self>
) -> &'a mut [Self]

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

impl Debug for AdtDef[src]

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

Formats the value using the given formatter. Read more

impl<S: Encoder> Encodable<S> for AdtDef[src]

fn encode(&self, s: &mut S) -> Result<(), S::Error>[src]

impl Hash for AdtDef[src]

fn hash<H: Hasher>(&self, s: &mut H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

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

impl<'a> HashStable<StableHashingContext<'a>> for AdtDef[src]

fn hash_stable(
    &self,
    hcx: &mut StableHashingContext<'a>,
    hasher: &mut StableHasher
)
[src]

impl Ord for AdtDef[src]

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

fn cmp(&self, other: &AdtDef) -> Ordering[src]

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

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl PartialEq<AdtDef> for AdtDef[src]

fn eq(&self, other: &Self) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialOrd<AdtDef> for AdtDef[src]

fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl<'tcx, D: TyDecoder<'tcx>> RefDecodable<'tcx, D> for AdtDef[src]

fn decode(decoder: &mut D) -> Result<&'tcx Self, D::Error>[src]

impl<'tcx> TypeFoldable<'tcx> for &'tcx AdtDef[src]

AdtDefs are basically the same as a DefId.

fn super_fold_with<F: TypeFolder<'tcx>>(self, _folder: &mut F) -> Self[src]

fn super_visit_with<V: TypeVisitor<'tcx>>(
    &self,
    _visitor: &mut V
) -> ControlFlow<V::BreakTy>
[src]

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self[src]

fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>
[src]

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool[src]

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

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool[src]

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

fn has_escaping_bound_vars(&self) -> bool[src]

fn has_type_flags(&self, flags: TypeFlags) -> bool[src]

fn has_projections(&self) -> bool[src]

fn has_opaque_types(&self) -> bool[src]

fn references_error(&self) -> bool[src]

fn has_param_types_or_consts(&self) -> bool[src]

fn has_infer_regions(&self) -> bool[src]

fn has_infer_types(&self) -> bool[src]

fn has_infer_types_or_consts(&self) -> bool[src]

fn needs_infer(&self) -> bool[src]

fn has_placeholders(&self) -> bool[src]

fn needs_subst(&self) -> bool[src]

fn has_free_regions(&self) -> bool[src]

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

fn has_erased_regions(&self) -> bool[src]

fn has_erasable_regions(&self) -> bool[src]

True if there are any un-erased free regions.

fn is_global(&self) -> bool[src]

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

fn has_late_bound_regions(&self) -> bool[src]

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool[src]

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

impl Eq for AdtDef[src]

Auto Trait Implementations

impl RefUnwindSafe for AdtDef

impl !Send for AdtDef

impl !Sync for AdtDef

impl Unpin for AdtDef

impl UnwindSafe for AdtDef

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> MaybeResult<T> for T[src]

type Error = !

pub fn from(Result<T, <T as MaybeResult<T>>::Error>) -> T[src]

pub fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<T> WithConstness for T[src]

fn with_constness(self, constness: Constness) -> ConstnessAnd<Self>[src]

fn with_const(self) -> ConstnessAnd<Self>[src]

fn without_const(self) -> ConstnessAnd<Self>[src]

impl<'a, T> Captures<'a> for T where
    T: ?Sized
[src]