pub struct Pointer<Prov = CtfeProvenance> {
    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) -> Size
where 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_invalid(addr: u64) -> Self

Creates a pointer to the given address, with invalid provenance (i.e., cannot be used for any memory access).

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<Prov, __D: TyDecoder> 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<Prov, __E: TyEncoder> 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 From<CtfeProvenance> for Pointer

source§

fn from(prov: CtfeProvenance) -> 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 IntoDiagnosticArg for Pointer<AllocId>

source§

impl<Prov: PartialEq> PartialEq 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> StructuralPartialEq for Pointer<Prov>

Auto Trait Implementations§

§

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

§

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

§

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

impl<T> AnyEq for T
where T: Any + PartialEq,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

fn as_any(&self) -> &(dyn Any + 'static)

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<Tcx, T> DepNodeParams<Tcx> for T
where 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) -> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> Filterable for T

§

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§

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>

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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> ToString for T
where 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 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

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,

§

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

§

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.