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

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

Represents a pointer in the Miri engine.

Pointer is generic over the Tag associated with each pointer, which is used to do provenance tracking during execution.

Fields

alloc_id: AllocId

offset: Size

tag: Tag

Implementations

impl Pointer<()>

pub fn new(alloc_id: AllocId, offset: Size) -> Self

pub fn with_tag<Tag>(self, tag: Tag) -> Pointer<Tag>

impl<'tcx, Tag> Pointer<Tag>

pub fn new_with_tag(alloc_id: AllocId, offset: Size, 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

pub fn erase_tag(self) -> Pointer

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

impl Debug for Pointer<()>

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

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

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

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

Formats the value using the given formatter.

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

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

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

impl From<AllocId> for Pointer

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

pub fn from(alloc_id: AllocId) -> Self

Performs the conversion.

impl<Tag> From<Pointer<Tag>> for Scalar<Tag>

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

Performs the conversion.

impl<Tag> From<Pointer<Tag>> for ScalarMaybeUninit<Tag>

pub fn from(s: Pointer<Tag>) -> Self

Performs the conversion.

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

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

Feeds this value into the given Hasher.

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

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

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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

impl<Tag> StructuralEq for Pointer<Tag>

impl<Tag> StructuralPartialEq for Pointer<Tag>