pub struct Pointer<Prov = AllocId> {
    pub(super) offset: Size,
    pub provenance: Prov,
}
Expand description

Represents a pointer in the Miri engine.

Pointers are “tagged” with provenance information; typically the AllocId they belong to.

Fields§

§offset: Size§provenance: Prov

Implementations§

source§

impl<Prov> Pointer<Option<Prov>>

source

pub fn into_pointer_or_addr(self) -> Result<Pointer<Prov>, Size>

Convert this pointer that might have a provenance into a pointer that definitely has a provenance, or an absolute address.

This is rarely what you want; call ptr_try_get_alloc_id instead.

source

pub fn addr(self) -> Sizewhere
Prov: Provenance,

Returns the absolute address the pointer points to. Only works if Prov::OFFSET_IS_ADDR is true!

source§

impl<Prov> Pointer<Option<Prov>>

source

pub fn from_addr(addr: u64) -> Self

source

pub fn null() -> Self

source§

impl<'tcx, Prov> Pointer<Prov>

source

pub fn new(provenance: Prov, offset: Size) -> Self

source

pub fn into_parts(self) -> (Prov, Size)

Obtain the constituents of this pointer. Not that the meaning of the offset depends on the type Prov! This function must only be used in the implementation of Machine::ptr_get_alloc, and when a Pointer is taken apart to be stored efficiently in an Allocation.

source

pub fn map_provenance(self, f: impl FnOnce(Prov) -> Prov) -> Self

source

pub fn offset(self, i: Size, cx: &impl HasDataLayout) -> InterpResult<'tcx, Self>

source

pub fn overflowing_offset(self, i: Size, cx: &impl HasDataLayout) -> (Self, bool)

source

pub fn wrapping_offset(self, i: Size, cx: &impl HasDataLayout) -> Self

source

pub fn signed_offset(
self,
i: i64,
cx: &impl HasDataLayout
) -> InterpResult<'tcx, Self>

source

pub fn overflowing_signed_offset(
self,
i: i64,
cx: &impl HasDataLayout
) -> (Self, bool)

source

pub fn wrapping_signed_offset(self, i: i64, cx: &impl HasDataLayout) -> Self

Trait Implementations§

source§

impl<Prov: Clone> Clone for Pointer<Prov>

source§

fn clone(&self) -> Pointer<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: Provenance> Debug for Pointer<Option<Prov>>

source§

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

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

impl<Prov: Provenance> Debug for Pointer<Prov>

source§

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

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

impl<'tcx, Prov, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for Pointer<Prov>where
Prov: Decodable<__D>,

source§

fn decode(__decoder: &mut __D) -> Self

source§

impl<Prov: Provenance> Display for Pointer<Option<Prov>>

source§

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

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

impl<'tcx, Prov, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for Pointer<Prov>where
Prov: Encodable<__E>,

source§

fn encode(&self, __encoder: &mut __E)

source§

impl From<AllocId> for Pointer

Produces a Pointer that points to the beginning of the Allocation.

source§

fn from(alloc_id: AllocId) -> Self

Converts to this type from the input type.
source§

impl<Prov> From<Pointer<Prov>> for Pointer<Option<Prov>>

source§

fn from(ptr: Pointer<Prov>) -> Self

Converts to this type from the input type.
source§

impl<Prov: Hash> Hash for Pointer<Prov>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Pointer<Prov>where
Prov: HashStable<StableHashingContext<'__ctx>>,

source§

fn hash_stable(
&self,
__hcx: &mut StableHashingContext<'__ctx>,
__hasher: &mut StableHasher
)

source§

impl<Prov: PartialEq> PartialEq<Pointer<Prov>> for Pointer<Prov>

source§

fn eq(&self, other: &Pointer<Prov>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<Prov: Copy> Copy for Pointer<Prov>

source§

impl<Prov: Eq> Eq for Pointer<Prov>

source§

impl<Prov> StructuralEq for Pointer<Prov>

source§

impl<Prov> StructuralPartialEq for Pointer<Prov>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<Tcx, T> DepNodeParams<Tcx> for Twhere
Tcx: DepContext,
T: for<'a> HashStable<StableHashingContext<'a>> + Debug,

source§

default fn fingerprint_style() -> FingerprintStyle

source§

default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint

This method turns the parameters of a DepNodeConstructor into an opaque Fingerprint to be used in DepNode. Not all DepNodeParams support being turned into a Fingerprint (they don’t need to if the corresponding DepNode is anonymous).
source§

default fn to_debug_str(&self, _: Tcx) -> String

source§

default fn recover(
_: Tcx,
_: &DepNode<<Tcx as DepContext>::DepKind>
) -> Option<T>

This method tries to recover the query key from the given DepNode, something which is needed when forcing DepNodes during red-green evaluation. The query system will only call this method if fingerprint_style() is not FingerprintStyle::Opaque. It is always valid to return None here, in which case incremental compilation will treat the query as having changed instead of forcing it.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, R> InternIteratorElement<T, R> for T

§

type Output = R

source§

fn intern_with<I, F>(iter: I, f: F) -> <T as InternIteratorElement<T, R>>::Outputwhere
I: Iterator<Item = T>,
F: FnOnce(&[T]) -> R,

source§

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

const: unstable · 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> 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> ToOwned for Twhere
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> ToString for Twhere
T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<Tcx, T, D> Value<Tcx, D> for Twhere
Tcx: DepContext,
D: DepKind,

source§

default fn from_cycle_error(tcx: Tcx, _: &[QueryInfo<D>]) -> T

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.