# Enum rustc_const_eval::interpret::operand::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_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.

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

#### fn into_query_param(self) -> P

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

source§

#### const ALIGN: usize = _

The alignment of pointer.
§

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

§

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