Struct rustc_mir::interpret::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) -> Pointer<()>

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) -> Pointer<Tag>

pub fn offset(
    self,
    i: Size,
    cx: &impl HasDataLayout
) -> Result<Pointer<Tag>, InterpErrorInfo<'tcx>>

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

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

pub fn signed_offset(
    self,
    i: i64,
    cx: &impl HasDataLayout
) -> Result<Pointer<Tag>, InterpErrorInfo<'tcx>>

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

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

pub fn erase_tag(self) -> Pointer<()>

Trait Implementations

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

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> Copy for Pointer<Tag> where
    Tag: Copy, 

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

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

Formats the value using the given formatter.

impl Debug for Pointer<()>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

impl From<AllocId> for Pointer<()>

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

fn from(alloc_id: AllocId) -> Pointer<()>

Performs the conversion.

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

fn from(s: Pointer<Tag>) -> ScalarMaybeUninit<Tag>

Performs the conversion.

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

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

Performs the conversion.

impl<Tag> From<Pointer<Tag>> for Immediate<Tag>

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

Performs the conversion.

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

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

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<Tag> Ord for Pointer<Tag> where
    Tag: Ord, 

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]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<Pointer<Tag>> for Pointer<Tag> where
    Tag: PartialEq<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<Pointer<Tag>> for Pointer<Tag> where
    Tag: PartialOrd<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: &Pointer<Tag>) -> bool

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

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.

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

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

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.