Enum rustc_middle::mir::interpret::Scalar
source · pub enum Scalar<Prov = AllocId> {
Int(ScalarInt),
Ptr(Pointer<Prov>, u8),
}
Expand description
A Scalar
represents an immediate, primitive value existing outside of a
memory::Allocation
. It is in many ways like a small chunk of an Allocation
, up to 16 bytes in
size. Like a range of bytes in an Allocation
, a Scalar
can either represent the raw bytes
of a simple value or a pointer into another Allocation
These variants would be private if there was a convenient way to achieve that in Rust.
Do not match on a Scalar
! Use the various to_*
methods instead.
Variants§
Int(ScalarInt)
The raw bytes of a simple value.
Ptr(Pointer<Prov>, u8)
A pointer.
We also store the size of the pointer, such that a Scalar
always knows how big it is.
The size is always the pointer size of the current target, but this is not information
that we always have readily available.
Implementations§
source§impl<Prov> Scalar<Prov>
impl<Prov> Scalar<Prov>
pub fn from_pointer(ptr: Pointer<Prov>, cx: &impl HasDataLayout) -> Self
sourcepub fn from_maybe_pointer(
ptr: Pointer<Option<Prov>>,
cx: &impl HasDataLayout
) -> Self
pub fn from_maybe_pointer( ptr: Pointer<Option<Prov>>, cx: &impl HasDataLayout ) -> Self
Create a Scalar from a pointer with an Option<_>
provenance (where None
represents a
plain integer / “invalid” pointer).
pub fn null_ptr(cx: &impl HasDataLayout) -> Self
pub fn from_bool(b: bool) -> Self
pub fn from_char(c: char) -> Self
pub fn try_from_uint(i: impl Into<u128>, size: Size) -> Option<Self>
pub fn from_uint(i: impl Into<u128>, size: Size) -> Self
pub fn from_u8(i: u8) -> Self
pub fn from_u16(i: u16) -> Self
pub fn from_u32(i: u32) -> Self
pub fn from_u64(i: u64) -> Self
pub fn from_u128(i: u128) -> Self
pub fn from_target_usize(i: u64, cx: &impl HasDataLayout) -> Self
pub fn try_from_int(i: impl Into<i128>, size: Size) -> Option<Self>
pub fn from_int(i: impl Into<i128>, size: Size) -> Self
pub fn from_i8(i: i8) -> Self
pub fn from_i16(i: i16) -> Self
pub fn from_i32(i: i32) -> Self
pub fn from_i64(i: i64) -> Self
pub fn from_target_isize(i: i64, cx: &impl HasDataLayout) -> Self
pub fn from_f32(f: Single) -> Self
pub fn from_f64(f: Double) -> Self
sourcepub fn to_bits_or_ptr_internal(
self,
target_size: Size
) -> Result<Either<u128, Pointer<Prov>>, ScalarSizeMismatch>
pub fn to_bits_or_ptr_internal( self, target_size: Size ) -> Result<Either<u128, Pointer<Prov>>, ScalarSizeMismatch>
This is almost certainly not the method you want! You should dispatch on the type
and use to_{u8,u16,...}
/scalar_to_ptr
to perform ptr-to-int / int-to-ptr casts as needed.
This method only exists for the benefit of low-level operations that truly need to treat the scalar in whatever form it is.
This throws UB (instead of ICEing) on a size mismatch since size mismatches can arise in
Miri when someone declares a function that we shim (such as malloc
) with a wrong type.
pub fn size(self) -> Size
source§impl<'tcx, Prov: Provenance> Scalar<Prov>
impl<'tcx, Prov: Provenance> Scalar<Prov>
pub fn to_pointer( self, cx: &impl HasDataLayout ) -> InterpResult<'tcx, Pointer<Option<Prov>>>
sourcepub fn try_to_int(self) -> Result<ScalarInt, Scalar<AllocId>>
pub fn try_to_int(self) -> Result<ScalarInt, Scalar<AllocId>>
Fundamental scalar-to-int (cast) operation. Many convenience wrappers exist below, that you likely want to use instead.
Will perform ptr-to-int casts if needed and possible. If that fails, we know the offset is relative, so we return an “erased” Scalar (which is useful for error messages but not much else).
pub fn assert_int(self) -> ScalarInt
sourcepub fn to_bits(self, target_size: Size) -> InterpResult<'tcx, u128>
pub fn to_bits(self, target_size: Size) -> InterpResult<'tcx, u128>
This throws UB (instead of ICEing) on a size mismatch since size mismatches can arise in
Miri when someone declares a function that we shim (such as malloc
) with a wrong type.
pub fn assert_bits(self, target_size: Size) -> u128
pub fn to_bool(self) -> InterpResult<'tcx, bool>
pub fn to_char(self) -> InterpResult<'tcx, char>
sourcepub fn to_uint(self, size: Size) -> InterpResult<'tcx, u128>
pub fn to_uint(self, size: Size) -> InterpResult<'tcx, u128>
Converts the scalar to produce an unsigned integer of the given size. Fails if the scalar is a pointer.
sourcepub fn to_u8(self) -> InterpResult<'tcx, u8>
pub fn to_u8(self) -> InterpResult<'tcx, u8>
Converts the scalar to produce a u8
. Fails if the scalar is a pointer.
sourcepub fn to_u16(self) -> InterpResult<'tcx, u16>
pub fn to_u16(self) -> InterpResult<'tcx, u16>
Converts the scalar to produce a u16
. Fails if the scalar is a pointer.
sourcepub fn to_u32(self) -> InterpResult<'tcx, u32>
pub fn to_u32(self) -> InterpResult<'tcx, u32>
Converts the scalar to produce a u32
. Fails if the scalar is a pointer.
sourcepub fn to_u64(self) -> InterpResult<'tcx, u64>
pub fn to_u64(self) -> InterpResult<'tcx, u64>
Converts the scalar to produce a u64
. Fails if the scalar is a pointer.
sourcepub fn to_u128(self) -> InterpResult<'tcx, u128>
pub fn to_u128(self) -> InterpResult<'tcx, u128>
Converts the scalar to produce a u128
. Fails if the scalar is a pointer.
sourcepub fn to_target_usize(self, cx: &impl HasDataLayout) -> InterpResult<'tcx, u64>
pub fn to_target_usize(self, cx: &impl HasDataLayout) -> InterpResult<'tcx, u64>
Converts the scalar to produce a machine-pointer-sized unsigned integer. Fails if the scalar is a pointer.
sourcepub fn to_int(self, size: Size) -> InterpResult<'tcx, i128>
pub fn to_int(self, size: Size) -> InterpResult<'tcx, i128>
Converts the scalar to produce a signed integer of the given size. Fails if the scalar is a pointer.
sourcepub fn to_i8(self) -> InterpResult<'tcx, i8>
pub fn to_i8(self) -> InterpResult<'tcx, i8>
Converts the scalar to produce an i8
. Fails if the scalar is a pointer.
sourcepub fn to_i16(self) -> InterpResult<'tcx, i16>
pub fn to_i16(self) -> InterpResult<'tcx, i16>
Converts the scalar to produce an i16
. Fails if the scalar is a pointer.
sourcepub fn to_i32(self) -> InterpResult<'tcx, i32>
pub fn to_i32(self) -> InterpResult<'tcx, i32>
Converts the scalar to produce an i32
. Fails if the scalar is a pointer.
sourcepub fn to_i64(self) -> InterpResult<'tcx, i64>
pub fn to_i64(self) -> InterpResult<'tcx, i64>
Converts the scalar to produce an i64
. Fails if the scalar is a pointer.
sourcepub fn to_i128(self) -> InterpResult<'tcx, i128>
pub fn to_i128(self) -> InterpResult<'tcx, i128>
Converts the scalar to produce an i128
. Fails if the scalar is a pointer.
sourcepub fn to_target_isize(self, cx: &impl HasDataLayout) -> InterpResult<'tcx, i64>
pub fn to_target_isize(self, cx: &impl HasDataLayout) -> InterpResult<'tcx, i64>
Converts the scalar to produce a machine-pointer-sized signed integer. Fails if the scalar is a pointer.
pub fn to_float<F: Float>(self) -> InterpResult<'tcx, F>
pub fn to_f32(self) -> InterpResult<'tcx, Single>
pub fn to_f64(self) -> InterpResult<'tcx, Double>
Trait Implementations§
source§impl<Prov: Provenance> Debug for Scalar<Prov>
impl<Prov: Provenance> Debug for Scalar<Prov>
source§impl<'tcx, Prov, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for Scalar<Prov>where
Prov: Decodable<__D>,
impl<'tcx, Prov, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for Scalar<Prov>where Prov: Decodable<__D>,
source§impl<Prov: Provenance> Display for Scalar<Prov>
impl<Prov: Provenance> Display for Scalar<Prov>
source§impl<'tcx, Prov, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Scalar<Prov>where
Prov: Encodable<__E>,
impl<'tcx, Prov, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Scalar<Prov>where Prov: Encodable<__E>,
source§impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Scalar<Prov>where
Prov: HashStable<StableHashingContext<'__ctx>>,
impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Scalar<Prov>where Prov: HashStable<StableHashingContext<'__ctx>>,
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher )
source§impl<Prov: Provenance> LowerHex for Scalar<Prov>
impl<Prov: Provenance> LowerHex for Scalar<Prov>
source§impl<Prov: PartialEq> PartialEq<Scalar<Prov>> for Scalar<Prov>
impl<Prov: PartialEq> PartialEq<Scalar<Prov>> for Scalar<Prov>
source§impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Scalar
impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for Scalar
source§fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'tcx>>>(
self,
_: &mut F
) -> Result<Self, F::Error>
fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, _: &mut F ) -> Result<Self, F::Error>
source§impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Scalar
impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for Scalar
source§fn visit_with<F: TypeVisitor<TyCtxt<'tcx>>>(
&self,
_: &mut F
) -> ControlFlow<F::BreakTy>
fn visit_with<F: TypeVisitor<TyCtxt<'tcx>>>( &self, _: &mut F ) -> ControlFlow<F::BreakTy>
impl<Prov: Copy> Copy for Scalar<Prov>
impl<Prov: Eq> Eq for Scalar<Prov>
impl<Prov> StructuralEq for Scalar<Prov>
impl<Prov> StructuralPartialEq for Scalar<Prov>
Auto Trait Implementations§
impl<Prov> RefUnwindSafe for Scalar<Prov>where Prov: RefUnwindSafe,
impl<Prov> Send for Scalar<Prov>where Prov: Send,
impl<Prov> Sync for Scalar<Prov>where Prov: Sync,
impl<Prov> Unpin for Scalar<Prov>where Prov: Unpin,
impl<Prov> UnwindSafe for Scalar<Prov>where Prov: UnwindSafe,
Blanket Implementations§
source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere T: Copy,
fn allocate_on<'a>(self, arena: &'a Arena<'tcx>) -> &'a mut T
fn allocate_from_iter<'a>( arena: &'a Arena<'tcx>, iter: impl IntoIterator<Item = T> ) -> &'a mut [T]
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
source§impl<Tcx, T> DepNodeParams<Tcx> for Twhere
Tcx: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
impl<Tcx, T> DepNodeParams<Tcx> for Twhere Tcx: DepContext, T: for<'a> HashStable<StableHashingContext<'a>> + Debug,
default fn fingerprint_style() -> FingerprintStyle
source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s 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<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
source§impl<'tcx, T> IsSuggestable<'tcx> for Twhere
T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
impl<'tcx, T> IsSuggestable<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>> + TypeFoldable<TyCtxt<'tcx>>,
source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
source§impl<'tcx, T> ToPredicate<'tcx, T> for T
impl<'tcx, T> ToPredicate<'tcx, T> for T
fn to_predicate(self, _tcx: TyCtxt<'tcx>) -> T
source§impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere
T: TypeVisitable<TyCtxt<'tcx>>,
impl<'tcx, T> TypeVisitableExt<'tcx> for Twhere T: TypeVisitable<TyCtxt<'tcx>>,
source§fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool
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 has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool
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
fn has_escaping_bound_vars(&self) -> bool
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 morefn has_type_flags(&self, flags: TypeFlags) -> bool
fn has_projections(&self) -> bool
fn has_inherent_projections(&self) -> bool
fn has_opaque_types(&self) -> bool
fn has_generators(&self) -> bool
fn references_error(&self) -> bool
fn error_reported(&self) -> Result<(), ErrorGuaranteed>
fn has_non_region_param(&self) -> bool
fn has_infer_regions(&self) -> bool
fn has_infer_types(&self) -> bool
fn has_non_region_infer(&self) -> bool
fn has_infer(&self) -> bool
fn has_placeholders(&self) -> bool
fn has_non_region_placeholders(&self) -> bool
fn has_param(&self) -> bool
source§fn has_free_regions(&self) -> bool
fn has_free_regions(&self) -> bool
fn has_erased_regions(&self) -> bool
source§fn has_erasable_regions(&self) -> bool
fn has_erasable_regions(&self) -> bool
source§fn is_global(&self) -> bool
fn is_global(&self) -> bool
source§fn has_late_bound_regions(&self) -> bool
fn has_late_bound_regions(&self) -> bool
source§fn has_non_region_late_bound(&self) -> bool
fn has_non_region_late_bound(&self) -> bool
source§fn has_late_bound_vars(&self) -> bool
fn has_late_bound_vars(&self) -> bool
source§fn still_further_specializable(&self) -> bool
fn still_further_specializable(&self) -> bool
impl
specialization.source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle: &[QueryInfo], _guar: ErrorGuaranteed ) -> T
Layout§
Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.