rustc_const_eval::interpret

Enum Immediate

Source 
pub enum Immediate<Prov: Provenance = CtfeProvenance> {
    Scalar(Scalar<Prov>),
    ScalarPair(Scalar<Prov>, Scalar<Prov>),
    Uninit,
}
Expand description

An Immediate represents a single immediate self-contained Rust value.

For optimization of a few very common cases, there is also a representation for a pair of primitive values (ScalarPair). It allows Miri to avoid making allocations for checked binary operations and wide pointers. This idea was taken from rustc’s codegen. In particular, thanks to ScalarPair, arithmetic operations and casts can be entirely defined on Immediate, and do not have to work with a Place.

Variants§

§

Scalar(Scalar<Prov>)

A single scalar value (must have initialized Scalar ABI).

§

ScalarPair(Scalar<Prov>, Scalar<Prov>)

A pair of two scalar value (must have ScalarPair ABI where both fields are Scalar::Initialized).

§

Uninit

A value of fully uninitialized memory. Can have arbitrary size and layout, but must be sized.

Implementations§

Source§

impl<Prov: Provenance> Immediate<Prov>

Source

pub fn new_pointer_with_meta( ptr: Pointer<Option<Prov>>, meta: MemPlaceMeta<Prov>, cx: &impl HasDataLayout, ) -> Self

Source

pub fn new_slice( ptr: Pointer<Option<Prov>>, len: u64, cx: &impl HasDataLayout, ) -> Self

Source

pub fn new_dyn_trait( val: Pointer<Option<Prov>>, vtable: Pointer<Option<Prov>>, cx: &impl HasDataLayout, ) -> Self

Source

pub fn to_scalar(self) -> Scalar<Prov>

Source

pub fn to_scalar_int(self) -> ScalarInt

Source

pub fn to_scalar_pair(self) -> (Scalar<Prov>, Scalar<Prov>)

Source

pub fn to_scalar_and_meta(self) -> (Scalar<Prov>, MemPlaceMeta<Prov>)

Returns the scalar from the first component and optionally the 2nd component as metadata.

Source

pub fn assert_matches_abi( self, abi: BackendRepr, msg: &str, cx: &impl HasDataLayout, )

Assert that this immediate is a valid value for the given ABI.

Source

pub fn clear_provenance<'tcx>(&mut self) -> InterpResult<'tcx>

Trait Implementations§

Source§

impl<Prov: Clone + Provenance> Clone for Immediate<Prov>

Source§

fn clone(&self) -> Immediate<Prov>

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<Prov: Debug + Provenance> Debug for Immediate<Prov>

Source§

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

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

impl<Prov: Provenance> From<Scalar<Prov>> for Immediate<Prov>

Source§

fn from(val: Scalar<Prov>) -> Self

Converts to this type from the input type.
Source§

impl<Prov: Copy + Provenance> Copy for Immediate<Prov>

Auto Trait Implementations§

§

impl<Prov> DynSend for Immediate<Prov>
where Prov: DynSend,

§

impl<Prov> DynSync for Immediate<Prov>
where Prov: DynSync,

§

impl<Prov> Freeze for Immediate<Prov>
where Prov: Freeze,

§

impl<Prov> RefUnwindSafe for Immediate<Prov>
where Prov: RefUnwindSafe,

§

impl<Prov> Send for Immediate<Prov>
where Prov: Send,

§

impl<Prov> Sync for Immediate<Prov>
where Prov: Sync,

§

impl<Prov> Unpin for Immediate<Prov>
where Prov: Unpin,

§

impl<Prov> UnwindSafe for Immediate<Prov>
where Prov: UnwindSafe,

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
§

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

§

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

§

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

Source§

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

Source§

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

Source§

fn allocate_from_iter( arena: &'tcx Arena<'tcx>, iter: impl IntoIterator<Item = T>, ) -> &'tcx 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

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

§

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<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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<P> IntoQueryParam<P> for P

Source§

fn into_query_param(self) -> P

Source§

impl<T> MaybeResult<T> for T

Source§

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> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

§

fn upcast(self, interner: I) -> U

§

impl<I, T> UpcastFrom<I, T> for T

§

fn upcast_from(from: T, _tcx: I) -> T

Source§

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

Source§

fn vzip(self) -> V

§

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

§

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
where T: Send + Sync,

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.