Struct StuffedPtr

pub struct StuffedPtr<T, S, B = usize>(/* private fields */)
where
    S: StuffingStrategy<B>,
    B: Backend<T>;

A union of a pointer or some other data, bitpacked into a value with the size depending on B. It defaults to usize, meaning pointer sized, but u64 and u128 are also provided by this crate. You can also provide your own Backend implementation

The stuffing strategy is supplied as the second generic parameter S.

The first generic parameter T is the type that the pointer is pointing to.

For a usage example, view the crate level documentation.

This pointer does not drop other data, StuffedPtr::into_other can be used if that is required.

StuffedPtr implements most traits like Clone, PartialEq or Copy if the other type does.

This type is guaranteed to be #[repr(transparent)] to a B::Stored.

Implementations

impl<T, S, B> StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, B: Backend<T>,

pub fn new_ptr(ptr: *mut T) -> Self

Create a new StuffedPtr from a pointer

pub fn new_other(other: S::Other) -> Self

Create a new StuffPtr from other data

pub fn get_ptr(&self) -> Option<*mut T>

Get the pointer data, or None if it contains other data

pub unsafe fn get_ptr_unchecked(&self) -> *mut T

Get the unstuffed pointer data from the stuffed pointer, assuming that the StuffedPtr contains pointer data.

Safety

StuffedPtr must contain pointer data and not other data

pub fn into_other(self) -> Option<S::Other>

Get owned other data from this, or None if it contains pointer data

pub unsafe fn into_other_unchecked(self) -> S::Other

Turn this pointer into other data.

Safety

StuffedPtr must contain other data and not pointer

pub unsafe fn get_other(&self) -> Option<S::Other>

Get other data from this, or None if it contains pointer data

Safety

The caller must guarantee that only ever on Other exists if Other: !Copy

pub unsafe fn get_other_unchecked(&self) -> S::Other

Get other data from this

Safety

Must contain other data and not pointer data, and the caller must guarantee that only ever on Other exists if Other: !Copy

impl<T, S, B> StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: Copy, B: Backend<T>,

Extra implementations if the other type is Copy

pub fn copy_other(&self) -> Option<S::Other>

Get other data from this, or None if it’s pointer data

pub unsafe fn copy_other_unchecked(&self) -> S::Other

Get other data from this

Safety

Must contain other data and not pointer data,

Trait Implementations

impl<T, S, B> Clone for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: Clone, B: Backend<T>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, S, B> Debug for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: Debug, B: Backend<T>,

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

Formats the value using the given formatter.

impl<T, S, B> Hash for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: Hash, B: Backend<T>,

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<T, S, B> PartialEq for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: PartialEq, B: Backend<T>,

fn eq(&self, other: &Self) -> 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<T, S, B> Copy for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: Copy, B: Backend<T>,

impl<T, S, B> Eq for StuffedPtr<T, S, B>

where S: StuffingStrategy<B>, S::Other: PartialEq + Eq, B: Backend<T>,