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.

Enum ImmediateCopy item path

Variants§

Scalar(Scalar<Prov>)

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

Uninit

Implementations§

impl<Prov: Provenance> Immediate<Prov>

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

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

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

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

pub fn to_scalar_int(self) -> ScalarInt

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

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

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

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

Trait Implementations§

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

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

fn clone_from(&mut self, source: &Self)

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

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

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

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

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§

impl<T> Aligned for T

const ALIGN: Alignment = _

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere 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]

impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere 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]

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

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

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

fn collect_and_apply<I, F>(iter: I, f: F) -> Rwhere I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

type Output = R

impl<T> Filterable for T

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<P> IntoQueryParam<P> for P

fn into_query_param(self) -> P

impl<T> MaybeResult<T> for T

type Error = !

fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

impl<T> Pointable for T

const ALIGN: usize = _

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> Same for T

Enum Immediate

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,

impl<T> Any for T
where T: 'static + ?Sized,

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

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

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

impl<T, U> Into<U> for T
where U: From<T>,

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

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<'a, T> Captures<'a> for T
where T: ?Sized,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T
where T: Send + Sync,