Struct rustc_middle::mir::interpret::pointer::Pointer

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

Represents a pointer in the Miri engine.

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

Fields

offset: Size

provenance: Tag

Implementations

impl<Tag> Pointer<Option<Tag>>

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

impl<Tag> Pointer<Option<Tag>>

pub fn null() -> Self

impl<'tcx, Tag> Pointer<Tag>

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

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

Obtain the constituents of this pointer. Not that the meaning of the offset depends on the type Tag! 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(Tag) -> Tag) -> Self

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

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

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

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

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

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

Trait Implementations

impl<Tag: Clone> Clone for Pointer<Tag>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<'tcx, Tag, __D: TyDecoder<'tcx>> Decodable<__D> for Pointer<Tag> where
    Tag: Decodable<__D>, 

fn decode(__decoder: &mut __D) -> Result<Self, <__D as Decoder>::Error>

impl<'tcx, Tag, __E: TyEncoder<'tcx>> Encodable<__E> for Pointer<Tag> where
    Tag: Encodable<__E>, 

fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl From<AllocId> for Pointer

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

fn from(alloc_id: AllocId) -> Self

Performs the conversion.

impl<Tag> From<Pointer<Tag>> for Pointer<Option<Tag>>

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

Performs the conversion.

impl<Tag: Hash> Hash for Pointer<Tag>

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, 

Feeds a slice of this type into the given Hasher.

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

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

impl<Tag: Ord> Ord for Pointer<Tag>

fn cmp(&self, other: &Pointer<Tag>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Tag: PartialEq> PartialEq<Pointer<Tag>> for Pointer<Tag>

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

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

fn ne(&self, other: &Pointer<Tag>) -> bool

This method tests for !=.

impl<Tag: PartialOrd> PartialOrd<Pointer<Tag>> for Pointer<Tag>

fn partial_cmp(&self, other: &Pointer<Tag>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Tag: Copy> Copy for Pointer<Tag>

impl<Tag: Eq> Eq for Pointer<Tag>

impl<Tag> StructuralEq for Pointer<Tag>

impl<Tag> StructuralPartialEq for Pointer<Tag>

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.