# Enum miri::Immediate

source ·

    pub enum Immediate<Prov = CtfeProvenance>where
        Prov: Provenance,{
        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.

## Trait Implementations§

source§

### impl VisitProvenance for Immediate<Provenance>

source§

#### fn visit_provenance(&self, visit: &mut VisitWith<'_>)

## Auto Trait Implementations§

§

### 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> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
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> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

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

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

§

#### fn vzip(self) -> V

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