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>>
impl<Prov> Pointer<Option<Prov>>
Sourcepub fn into_pointer_or_addr(self) -> Result<Pointer<Prov>, Size>
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.
Sourcepub fn addr(self) -> Sizewhere
Prov: Provenance,
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>>
impl<Prov> Pointer<Option<Prov>>
Sourcepub fn from_addr_invalid(addr: u64) -> Self
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).
pub fn null() -> Self
Source§impl<Prov> Pointer<Prov>
impl<Prov> Pointer<Prov>
pub fn new(provenance: Prov, offset: Size) -> Self
Sourcepub fn into_parts(self) -> (Prov, Size)
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
.
pub fn map_provenance(self, f: impl FnOnce(Prov) -> Prov) -> Self
pub fn wrapping_offset(self, i: Size, cx: &impl HasDataLayout) -> Self
pub fn wrapping_signed_offset(self, i: i64, cx: &impl HasDataLayout) -> Self
Trait Implementations§
Source§impl<Prov: Provenance> Debug for Pointer<Prov>
impl<Prov: Provenance> Debug for Pointer<Prov>
Source§impl From<AllocId> for Pointer
impl From<AllocId> for Pointer
Produces a Pointer
that points to the beginning of the Allocation
.
Source§impl From<CtfeProvenance> for Pointer
impl From<CtfeProvenance> for Pointer
Source§fn from(prov: CtfeProvenance) -> Self
fn from(prov: CtfeProvenance) -> Self
Source§impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Pointer<Prov>where
Prov: HashStable<StableHashingContext<'__ctx>>,
impl<'__ctx, Prov> HashStable<StableHashingContext<'__ctx>> for Pointer<Prov>where
Prov: HashStable<StableHashingContext<'__ctx>>,
fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher, )
Source§impl IntoDiagArg for Pointer<AllocId>
impl IntoDiagArg for Pointer<AllocId>
fn into_diag_arg(self) -> DiagArgValue
impl<Prov: Copy> Copy for Pointer<Prov>
impl<Prov: Eq> Eq for Pointer<Prov>
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> Freeze for Pointer<Prov>where
Prov: Freeze,
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<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
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]
Source§impl<'tcx, T> ArenaAllocatable<'tcx, IsCopy> for Twhere
T: Copy,
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]
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
Source§impl<Tcx, T> DepNodeParams<Tcx> for T
impl<Tcx, T> DepNodeParams<Tcx> for T
default fn fingerprint_style() -> FingerprintStyle
Source§default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_fingerprint(&self, tcx: Tcx) -> Fingerprint
default fn to_debug_str(&self, _: Tcx) -> String
Source§default fn recover(_: Tcx, _: &DepNode) -> Option<T>
default fn recover(_: Tcx, _: &DepNode) -> Option<T>
DepNode
,
something which is needed when forcing DepNode
s 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
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> Filterable for T
impl<T> Filterable for T
Source§fn filterable(
self,
filter_name: &'static str,
) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<P> IntoQueryParam<P> for P
impl<P> IntoQueryParam<P> for P
fn into_query_param(self) -> P
Source§impl<T> MaybeResult<T> for T
impl<T> MaybeResult<T> for T
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
impl<I, T, U> Upcast<I, U> for Twhere
U: UpcastFrom<I, T>,
Source§impl<I, T> UpcastFrom<I, T> for T
impl<I, T> UpcastFrom<I, T> for T
fn upcast_from(from: T, _tcx: I) -> T
Source§impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
impl<Tcx, T> Value<Tcx> for Twhere
Tcx: DepContext,
default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
Source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeSendSync for 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.