Enum rustc_middle::mir::ConstantKind

pub enum ConstantKind<'tcx> {
    Ty(Const<'tcx>),
    Unevaluated(Unevaluated<'tcx, Option<Promoted>>, Ty<'tcx>),
    Val(ConstValue<'tcx>, Ty<'tcx>),
}

Variants

Ty(Const<'tcx>)

This constant came from the type system

Unevaluated(Unevaluated<'tcx, Option<Promoted>>, Ty<'tcx>)

An unevaluated mir constant which is not part of the type system.

Val(ConstValue<'tcx>, Ty<'tcx>)

This constant cannot go back into the type system, as it represents something the type system cannot handle (e.g. pointers).

Implementations

impl<'tcx> ConstantKind<'tcx>

pub fn ty(&self) -> Ty<'tcx>

pub fn try_to_value(self, tcx: TyCtxt<'tcx>) -> Option<ConstValue<'tcx>>

pub fn try_to_scalar(self) -> Option<Scalar>

pub fn try_to_scalar_int(self) -> Option<ScalarInt>

pub fn try_to_bits(self, size: Size) -> Option<u128>

pub fn try_to_bool(self) -> Option<bool>

pub fn eval(self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>) -> Self

pub fn eval_bits(
    self,
    tcx: TyCtxt<'tcx>,
    param_env: ParamEnv<'tcx>,
    ty: Ty<'tcx>
) -> u128

Panics if the value cannot be evaluated or doesn’t contain a valid integer of the given type.

pub fn try_eval_bits(
    &self,
    tcx: TyCtxt<'tcx>,
    param_env: ParamEnv<'tcx>,
    ty: Ty<'tcx>
) -> Option<u128>

pub fn try_eval_bool(
    &self,
    tcx: TyCtxt<'tcx>,
    param_env: ParamEnv<'tcx>
) -> Option<bool>

pub fn try_eval_usize(
    &self,
    tcx: TyCtxt<'tcx>,
    param_env: ParamEnv<'tcx>
) -> Option<u64>

pub fn from_value(val: ConstValue<'tcx>, ty: Ty<'tcx>) -> Self

pub fn from_bits(
    tcx: TyCtxt<'tcx>,
    bits: u128,
    param_env_ty: ParamEnvAnd<'tcx, Ty<'tcx>>
) -> Self

pub fn from_bool(tcx: TyCtxt<'tcx>, v: bool) -> Self

pub fn zero_sized(ty: Ty<'tcx>) -> Self

pub fn from_usize(tcx: TyCtxt<'tcx>, n: u64) -> Self

pub fn from_scalar(_tcx: TyCtxt<'tcx>, s: Scalar, ty: Ty<'tcx>) -> Self

pub fn from_anon_const(
    tcx: TyCtxt<'tcx>,
    def_id: LocalDefId,
    param_env: ParamEnv<'tcx>
) -> Self

Literals are converted to ConstantKindVal, const generic parameters are eagerly converted to a constant, everything else becomes Unevaluated.

pub fn from_inline_const(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> Self

fn from_opt_const_arg_anon_const(
    tcx: TyCtxt<'tcx>,
    def: WithOptConstParam<LocalDefId>,
    param_env: ParamEnv<'tcx>
) -> Self

pub fn from_const(c: Const<'tcx>, tcx: TyCtxt<'tcx>) -> Self

Trait Implementations

impl<'tcx> Clone for ConstantKind<'tcx>

fn clone(&self) -> ConstantKind<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for ConstantKind<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for ConstantKind<'tcx>

fn decode(__decoder: &mut __D) -> Self

impl<'tcx> Display for ConstantKind<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for ConstantKind<'tcx>

fn encode(&self, __encoder: &mut __E)

impl<'tcx> Hash for ConstantKind<'tcx>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for ConstantKind<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx, '__lifted> Lift<'__lifted> for ConstantKind<'tcx>

type Lifted = ConstantKind<'__lifted>

fn lift_to_tcx(self, __tcx: TyCtxt<'__lifted>) -> Option<ConstantKind<'__lifted>>

impl<'tcx> PartialEq<ConstantKind<'tcx>> for ConstantKind<'tcx>

fn eq(&self, other: &ConstantKind<'tcx>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<'tcx> for ConstantKind<'tcx>

fn try_fold_with<F: FallibleTypeFolder<'tcx>>(
    self,
    folder: &mut F
) -> Result<Self, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

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

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeSuperFoldable<'tcx> for ConstantKind<'tcx>

fn try_super_fold_with<F: FallibleTypeFolder<'tcx>>(
    self,
    folder: &mut F
) -> Result<Self, F::Error>

Provides a default fold for a type of interest. This should only be called within TypeFolder methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyFolder::try_fold_ty(ty), it is valid to call ty.try_super_fold_with(self), but any other folding should be done with xyz.try_fold_with(self).

fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_super_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_super_fold_with.

impl<'tcx> TypeSuperVisitable<'tcx> for ConstantKind<'tcx>

fn super_visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

Provides a default visit for a type of interest. This should only be called within TypeVisitor methods, when a non-custom traversal is desired for the value of the type of interest passed to that method. For example, in MyVisitor::visit_ty(ty), it is valid to call ty.super_visit_with(self), but any other visiting should be done with xyz.visit_with(self).

impl<'tcx> TypeVisitable<'tcx> for ConstantKind<'tcx>

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

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

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

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.

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

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

fn has_escaping_bound_vars(&self) -> bool

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

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Option<ErrorGuaranteed>

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

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

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

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.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

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.

impl<'tcx> Copy for ConstantKind<'tcx>

impl<'tcx> Eq for ConstantKind<'tcx>

impl<'tcx> StructuralEq for ConstantKind<'tcx>

impl<'tcx> StructuralPartialEq for ConstantKind<'tcx>

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

Size for each variant:

• Ty: 8 bytes
• Unevaluated: 40 bytes
• Val: 40 bytes