Struct uptr

pub struct uptr(/* private fields */);

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 usize to be exposed here.

Implementations

impl uptr

pub const MIN: uptr

pub const MAX: uptr

pub const BITS: u32 = 64u32

pub const fn from_int(val: usize) -> 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 for uptr

type Output = uptr

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for uptr

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd for uptr

type Output = uptr

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for uptr

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for uptr

type Output = uptr

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for uptr

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for uptr

type Output = uptr

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for uptr

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for uptr

fn clone(&self) -> uptr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for uptr

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

Formats the value using the given formatter.

impl Display for uptr

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

Formats the value using the given formatter.

impl Div for uptr

type Output = uptr

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for uptr

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<usize> for uptr

fn from(val: usize) -> Self

Converts to this type from the input type.

impl Hash for uptr

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

type Output = uptr

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for uptr

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for uptr

type Output = uptr

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for uptr

fn cmp(&self, other: &uptr) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for uptr

fn eq(&self, other: &uptr) -> 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 PartialOrd for uptr

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem for uptr

type Output = uptr

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for uptr

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Shl<usize> for uptr

type Output = uptr

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for uptr

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for uptr

type Output = uptr

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for uptr

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub for uptr

type Output = uptr

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for uptr

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for uptr

impl Eq for uptr

impl StructuralPartialEq for uptr