Struct sptr::int::iptr

#[repr(transparent)]
pub struct iptr(_);

A pointer that pretends to be an integer, for API Crimes.

Please don’t use this type.

If you can’t possibly satisfy strict provenance for whatever reason, you can at least use this type to make sure the compiler still understands that Pointers Are Happening.

All operations on this type will derive provenance from the left-hand-size (lhs). So x + y has x’s provenance. Many operations are nonsensical if the pointer inside is a real pointer, but hey, you’ve reached for the “I Know What I’m Doing” lever, so we’ll let you say whatever gibberish you want.

Please submit a PR if you need some operation defined on isize to be exposed here.

Implementations

impl iptr

pub const MIN: iptr = Self::from_int(core::isize::MIN)

pub const MAX: iptr = Self::from_int(core::isize::MAX)

pub const BITS: u32 = 64u32

pub const fn from_int(val: isize) -> Self

pub const fn from_ptr_mut<T>(val: *mut T) -> Self

pub const fn from_ptr<T>(val: *const T) -> Self

pub const fn to_ptr(self) -> *mut ()

pub fn wrapping_add(self, rhs: Self) -> Self

pub fn wrapping_sub(self, rhs: Self) -> Self

pub fn wrapping_mul(self, rhs: Self) -> Self

pub fn wrapping_div(self, rhs: Self) -> Self

Trait Implementations

impl Add<iptr> for iptr

type Output = iptr

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<iptr> for iptr

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd<iptr> for iptr

type Output = iptr

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<iptr> for iptr

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<iptr> for iptr

type Output = iptr

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<iptr> for iptr

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<iptr> for iptr

type Output = iptr

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<iptr> for iptr

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for iptr

fn clone(&self) -> iptr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for iptr

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

Formats the value using the given formatter.

impl Display for iptr

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

Formats the value using the given formatter.

impl Div<iptr> for iptr

type Output = iptr

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign<iptr> for iptr

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T> From<*const T> for iptr

fn from(val: *const T) -> Self

Converts to this type from the input type.

impl<T> From<*mut T> for iptr

fn from(val: *mut T) -> Self

Converts to this type from the input type.

impl From<isize> for iptr

fn from(val: isize) -> Self

Converts to this type from the input type.

impl Hash for iptr

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 Mul<iptr> for iptr

type Output = iptr

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<iptr> for iptr

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for iptr

type Output = iptr

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for iptr

type Output = iptr

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for iptr

fn cmp(&self, other: &iptr) -> 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 PartialEq<iptr> for iptr

fn eq(&self, other: &iptr) -> bool

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

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

This method tests for !=.

impl PartialOrd<iptr> for iptr

fn partial_cmp(&self, other: &iptr) -> 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 Rem<iptr> for iptr

type Output = iptr

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl RemAssign<iptr> for iptr

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Shl<usize> for iptr

type Output = iptr

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl ShlAssign<usize> for iptr

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for iptr

type Output = iptr

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<usize> for iptr

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<iptr> for iptr

type Output = iptr

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<iptr> for iptr

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for iptr

impl Eq for iptr

impl StructuralEq for iptr

impl StructuralPartialEq for iptr