[−][src]Struct tagged_box::TaggedPointer
A pointer that holds a data pointer plus additional data stored as a Discriminant
Note: The discriminant must be <= MAX_DISCRIMINANT
, which is feature-dependent
Methods
impl TaggedPointer
[src]
pub fn new(ptr: usize, discriminant: Discriminant) -> Self
[src]
Create a new tagged pointer from a pointer and a discriminant
Panics
Panics if discriminant
is greater than MAX_DISCRIMINANT
or if
ptr
is greater than MAX_POINTER_VALUE
pub unsafe fn new_unchecked(ptr: usize, discriminant: Discriminant) -> Self
[src]
Create a new tagged pointer from a pointer and a discriminant without checking invariance
Safety
discriminant
must be <= MAX_DISCRIMINANT
and pointer
must be <=
MAX_POINTER_VALUE
pub const fn discriminant(self) -> Discriminant
[src]
Fetches the discriminant of the tagged pointer
pub unsafe fn as_ref<T>(&self) -> &T
[src]
Gains a reference to the inner value of the pointer
Safety
The pointer given to TaggedPointer::new
must be properly aligned and non-null
pub unsafe fn as_mut_ref<T>(&mut self) -> &mut T
[src]
Gains a mutable reference to the inner value of the pointer
Safety
The pointer given to TaggedPointer::new
must be properly aligned and non-null
pub const fn as_usize(self) -> usize
[src]
Returns the pointer as a usize, removing the discriminant
pub const fn as_raw_usize(self) -> usize
[src]
Returns the raw tagged pointer, without removing the discriminant
Warning
Attempting to dereference this usize will not point to valid memory!
pub const fn as_ptr<T>(self) -> *const T
[src]
Converts a tagged pointer into a raw pointer, removing the discriminant
pub fn as_mut_ptr<T>(self) -> *mut T
[src]
Converts a tagged pointer into a raw pointer, removing the discriminant
pub fn store_discriminant(pointer: usize, discriminant: Discriminant) -> usize
[src]
Store a Discriminant
into a tagged pointer
Panics
Panics if discriminant
is greater than MAX_DISCRIMINANT
or if
ptr
is greater than MAX_POINTER_VALUE
pub unsafe fn store_discriminant_unchecked(
pointer: usize,
discriminant: Discriminant
) -> usize
[src]
pointer: usize,
discriminant: Discriminant
) -> usize
Store a Discriminant
into a tagged pointer without any checks
Safety
discriminant
must be <= MAX_DISCRIMINANT
and pointer
must be <=
MAX_POINTER_VALUE
pub const fn fetch_discriminant(pointer: usize) -> Discriminant
[src]
Fetch a Discriminant
from a tagged pointer
pub const fn strip_discriminant(pointer: usize) -> usize
[src]
Strip the Discriminant
from a tagged pointer, returning only the valid pointer as a usize
Trait Implementations
impl Binary for TaggedPointer
[src]
impl Clone for TaggedPointer
[src]
fn clone(&self) -> TaggedPointer
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for TaggedPointer
[src]
impl Debug for TaggedPointer
[src]
impl Eq for TaggedPointer
[src]
impl Hash for TaggedPointer
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for TaggedPointer
[src]
impl Octal for TaggedPointer
[src]
impl Ord for TaggedPointer
[src]
fn cmp(&self, other: &TaggedPointer) -> Ordering
[src]
#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<TaggedPointer> for TaggedPointer
[src]
fn eq(&self, other: &TaggedPointer) -> bool
[src]
fn ne(&self, other: &TaggedPointer) -> bool
[src]
impl PartialOrd<TaggedPointer> for TaggedPointer
[src]
fn partial_cmp(&self, other: &TaggedPointer) -> Option<Ordering>
[src]
fn lt(&self, other: &TaggedPointer) -> bool
[src]
fn le(&self, other: &TaggedPointer) -> bool
[src]
fn gt(&self, other: &TaggedPointer) -> bool
[src]
fn ge(&self, other: &TaggedPointer) -> bool
[src]
impl Pointer for TaggedPointer
[src]
impl StructuralEq for TaggedPointer
[src]
impl StructuralPartialEq for TaggedPointer
[src]
impl UpperHex for TaggedPointer
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,