pub enum Immediate<Tag = AllocId> where
    Tag: Provenance, 
{ Scalar(ScalarMaybeUninit<Tag>), ScalarPair(ScalarMaybeUninit<Tag>, ScalarMaybeUninit<Tag>), 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(ScalarMaybeUninit<Tag>)

A single scalar value (must have initialized Scalar ABI). FIXME: we also currently often use this for ZST. ScalarMaybeUninit should reject ZST, and we should use Uninit for them instead.

ScalarPair(ScalarMaybeUninit<Tag>, ScalarMaybeUninit<Tag>)

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 and size and layout.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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.