Struct rustc_middle::ty::consts::Const

source ·
pub struct Const<'tcx>(pub(super) Interned<'tcx, WithCachedTypeInfo<ConstData<'tcx>>>);
Expand description

Use this rather than ConstData, whenever possible.

Tuple Fields§

§0: Interned<'tcx, WithCachedTypeInfo<ConstData<'tcx>>>

Implementations§

source§

impl<'tcx> Const<'tcx>

source

pub fn walk(self) -> TypeWalker<'tcx>

Iterator that walks self and any types reachable from self, in depth-first order. Note that just walks the types that appear in self, it does not descend into the fields of structs or variants. For example:

isize => { isize }
Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
[isize] => { [isize], isize }
source§

impl<'tcx> Const<'tcx>

source

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

source

pub fn kind(self) -> ConstKind<'tcx>

source

pub fn flags(self) -> TypeFlags

source

pub fn outer_exclusive_binder(self) -> DebruijnIndex

source

pub fn new( tcx: TyCtxt<'tcx>, kind: ConstKind<'tcx>, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_param( tcx: TyCtxt<'tcx>, param: ParamConst, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_var(tcx: TyCtxt<'tcx>, infer: ConstVid, ty: Ty<'tcx>) -> Const<'tcx>

source

pub fn new_fresh(tcx: TyCtxt<'tcx>, fresh: u32, ty: Ty<'tcx>) -> Const<'tcx>

source

pub fn new_infer( tcx: TyCtxt<'tcx>, infer: InferConst, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_bound( tcx: TyCtxt<'tcx>, debruijn: DebruijnIndex, var: BoundVar, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_placeholder( tcx: TyCtxt<'tcx>, placeholder: PlaceholderConst, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_unevaluated( tcx: TyCtxt<'tcx>, uv: UnevaluatedConst<'tcx>, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_value( tcx: TyCtxt<'tcx>, val: ValTree<'tcx>, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_expr( tcx: TyCtxt<'tcx>, expr: Expr<'tcx>, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_error( tcx: TyCtxt<'tcx>, e: ErrorGuaranteed, ty: Ty<'tcx> ) -> Const<'tcx>

source

pub fn new_misc_error(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Const<'tcx>

Like Ty::new_error but for constants.

source

pub fn new_error_with_message<S: Into<MultiSpan>>( tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, span: S, msg: &'static str ) -> Const<'tcx>

Like Ty::new_error_with_message but for constants.

source§

impl<'tcx> Const<'tcx>

source

pub fn from_anon_const(tcx: TyCtxt<'tcx>, def: LocalDefId) -> Self

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

source

fn try_from_lit_or_param( tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, expr: &'tcx Expr<'tcx> ) -> Option<Self>

source

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

Creates a constant with the given integer value and interns it.

source

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

Creates an interned zst constant.

source

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

Creates an interned bool constant.

source

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

Creates an interned usize constant.

source

pub fn eval( self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx>, span: Span ) -> Result<ValTree<'tcx>, ErrorHandled>

Returns the evaluated constant

source

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

Normalizes the constant to a value or an error if possible.

source

pub fn try_eval_scalar( self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx> ) -> Option<Scalar>

source

pub fn try_eval_scalar_int( self, tcx: TyCtxt<'tcx>, param_env: ParamEnv<'tcx> ) -> Option<ScalarInt>

Attempts to evaluate the given constant to bits. Can fail to evaluate in the presence of generics (or erroneous code) or if the value can’t be represented as bits (e.g. because it contains const generic parameters or pointers).

source

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

Attempts to evaluate the given constant to bits. Can fail to evaluate in the presence of generics (or erroneous code) or if the value can’t be represented as bits (e.g. because it contains const generic parameters or pointers).

source

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

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

source

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

source

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

source

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

Panics if the value cannot be evaluated or doesn’t contain a valid usize.

source

pub fn to_valtree(self) -> ValTree<'tcx>

Panics if self.kind != ty::ConstKind::Value

source

pub fn try_to_valtree(self) -> Option<ValTree<'tcx>>

Attempts to convert to a ValTree

source

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

source

pub fn try_to_target_usize(self, tcx: TyCtxt<'tcx>) -> Option<u64>

source

pub fn is_ct_infer(self) -> bool

Trait Implementations§

source§

impl<'tcx> Clone for Const<'tcx>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'tcx> Const<TyCtxt<'tcx>> for Const<'tcx>

source§

fn new_anon_bound( tcx: TyCtxt<'tcx>, debruijn: DebruijnIndex, var: BoundVar, ty: Ty<'tcx> ) -> Self

source§

impl<'tcx> ConstTy<TyCtxt<'tcx>> for Const<'tcx>

source§

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

source§

impl<'tcx> Debug for Const<'tcx>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'tcx> DebugWithInfcx<TyCtxt<'tcx>> for Const<'tcx>

source§

fn fmt<Infcx: InferCtxtLike<Interner = TyCtxt<'tcx>>>( this: WithInfcx<'_, Infcx, &Self>, f: &mut Formatter<'_> ) -> Result

source§

impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<D> for Const<'tcx>

source§

fn decode(decoder: &mut D) -> Self

source§

impl<'tcx> Display for Const<'tcx>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'tcx, E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<E> for Const<'tcx>

source§

fn encode(&self, e: &mut E)

source§

impl<'tcx> EraseType for Const<'tcx>

§

type Result = [u8; 8]

source§

impl<'tcx> Flags for Const<'tcx>

source§

impl<'tcx> From<Const<'tcx>> for GenericArg<'tcx>

source§

fn from(c: Const<'tcx>) -> GenericArg<'tcx>

Converts to this type from the input type.
source§

impl<'tcx> From<Const<'tcx>> for Term<'tcx>

source§

fn from(c: Const<'tcx>) -> Self

Converts to this type from the input type.
source§

impl<'tcx> Hash for Const<'tcx>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

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

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

source§

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

source§

impl<'tcx> IntoKind for Const<'tcx>

§

type Kind = ConstKind<TyCtxt<'tcx>>

source§

fn kind(self) -> ConstKind<'tcx>

source§

impl<'tcx> Key for Const<'tcx>

§

type Cache<V> = DefaultCache<Const<'tcx>, V>

source§

fn default_span(&self, _: TyCtxt<'_>) -> Span

In the event that a cycle occurs, if no explicit span has been given for a query with key self, what span should we use?
source§

fn key_as_def_id(&self) -> Option<DefId>

If the key is a DefId or DefId–equivalent, return that DefId. Otherwise, return None.
source§

fn ty_def_id(&self) -> Option<DefId>

source§

impl<'a, 'tcx> Lift<'tcx> for Const<'a>

§

type Lifted = Const<'tcx>

source§

fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted>

source§

impl ParameterizedOverTcx for Const<'static>

§

type Value<'tcx> = Const<'tcx>

source§

impl<'tcx> PartialEq for Const<'tcx>

source§

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

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

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.
source§

impl<'tcx, P: Printer<'tcx>> Print<'tcx, P> for Const<'tcx>

source§

impl<'tcx> Relate<'tcx> for Const<'tcx>

source§

fn relate<R: TypeRelation<'tcx>>( relation: &mut R, a: Const<'tcx>, b: Const<'tcx> ) -> RelateResult<'tcx, Const<'tcx>>

source§

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Const<'tcx>

source§

fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'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). Read more
source§

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

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

impl<'tcx> TypeSuperFoldable<TyCtxt<'tcx>> for Const<'tcx>

source§

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

Provides a default fold for a recursive 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).
source§

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

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.
source§

impl<'tcx> TypeSuperVisitable<TyCtxt<'tcx>> for Const<'tcx>

source§

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

Provides a default visit for a recursive 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).
source§

impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Const<'tcx>

source§

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

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

impl<'tcx> Copy for Const<'tcx>

source§

impl<'tcx> Eq for Const<'tcx>

source§

impl<'tcx> StructuralPartialEq for Const<'tcx>

Auto Trait Implementations§

§

impl<'tcx> Freeze for Const<'tcx>

§

impl<'tcx> !RefUnwindSafe for Const<'tcx>

§

impl<'tcx> Send for Const<'tcx>

§

impl<'tcx> Sync for Const<'tcx>

§

impl<'tcx> Unpin for Const<'tcx>

§

impl<'tcx> !UnwindSafe for Const<'tcx>

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyEq for T
where T: Any + PartialEq,

source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

source§

fn as_any(&self) -> &(dyn Any + 'static)

source§

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

source§

fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T

source§

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

source§

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for T
where T: Copy,

source§

fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T

source§

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

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, R> CollectAndApply<T, R> for T

source§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

source§

impl<Tcx, T> DepNodeParams<Tcx> for T
where Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

source§

default fn fingerprint_style() -> FingerprintStyle

source§

default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
source§

default fn to_debug_str(&self, _: Tcx) -> String

source§

default fn recover(_: Tcx, _: &DepNode) -> Option<T>

This method tries to recover the query key from the given DepNode, something which is needed when forcing DepNodes during red-green evaluation. The query system will only call this method if fingerprint_style() is not FingerprintStyle::Opaque. It is always valid to return None here, in which case incremental compilation will treat the query as having changed instead of forcing it.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> Filterable for T

source§

fn filterable( self, filter_name: &'static str ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<P> IntoQueryParam<P> for P

source§

impl<'tcx, T> IsSuggestable<'tcx> for T
where T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,

source§

fn is_suggestable(self, tcx: TyCtxt<'tcx>, infer_suggestable: bool) -> bool

Whether this makes sense to suggest in a diagnostic. Read more
source§

fn make_suggestable( self, tcx: TyCtxt<'tcx>, infer_suggestable: bool, placeholder: Option<Ty<'tcx>> ) -> Option<T>

source§

impl<T> MaybeResult<T> for T

§

type Error = !

source§

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

source§

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<'tcx, T> ToPredicate<'tcx, T> for T

source§

fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<I, T> TypeVisitableExt<I> for T
where I: Interner, T: TypeVisitable<I>,

source§

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

source§

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.
source§

fn error_reported(&self) -> Result<(), <I as Interner>::ErrorGuaranteed>

source§

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

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

fn has_escaping_bound_vars(&self) -> bool

Return true if this type has regions that are not a part of the type. For example, for<'a> fn(&'a i32) return false, while fn(&'a i32) would return true. The latter can occur when traversing through the former. Read more
source§

fn has_aliases(&self) -> bool

source§

fn has_inherent_projections(&self) -> bool

source§

fn has_opaque_types(&self) -> bool

source§

fn has_coroutines(&self) -> bool

source§

fn references_error(&self) -> bool

source§

fn has_non_region_param(&self) -> bool

source§

fn has_infer_regions(&self) -> bool

source§

fn has_infer_types(&self) -> bool

source§

fn has_non_region_infer(&self) -> bool

source§

fn has_infer(&self) -> bool

source§

fn has_placeholders(&self) -> bool

source§

fn has_non_region_placeholders(&self) -> bool

source§

fn has_param(&self) -> bool

source§

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.
source§

fn has_erased_regions(&self) -> bool

source§

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.
source§

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.
source§

fn has_bound_regions(&self) -> bool

True if there are any late-bound regions
source§

fn has_non_region_bound_vars(&self) -> bool

True if there are any late-bound non-region variables
source§

fn has_bound_vars(&self) -> bool

True if there are any bound variables
source§

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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

source§

default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed ) -> T

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

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

source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T

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: 8 bytes