Struct Pointer

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

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

impl<Prov> Pointer<Option<Prov>>

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.

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!

impl<Prov> Pointer<Option<Prov>>

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

impl<Prov> Pointer<Prov>

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<Prov, __D: TyDecoder> Decodable<__D> for Pointer<Prov>

where Prov: Decodable<__D>,

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

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

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

Formats the value using the given formatter.

impl<Prov, __E: TyEncoder> Encodable<__E> for Pointer<Prov>

where Prov: Encodable<__E>,

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

impl From<AllocId> for Pointer

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

fn from(alloc_id: AllocId) -> Self

Converts to this type from the input type.

impl From<CtfeProvenance> for Pointer

fn from(prov: CtfeProvenance) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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, )

impl IntoDiagArg for Pointer<AllocId>

fn into_diag_arg(self) -> DiagArgValue

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

impl<Prov> StructuralPartialEq for Pointer<Prov>

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.