Struct flize::Shared

#[repr(transparent)]pub struct Shared<'shield, V, T1 = NullTag, T2 = NullTag> where
    V: 'shield,
    T1: Tag,
    T2: Tag,  { /* fields omitted */ }

A Shared represents a tagged pointer. It provides various utility methods for type conversion and tag manipulation. In addition it is the only pointer type that can be used to interact with Atomic since this type enforces a lifetime based on the shield used to create it.

Implementations

impl<'shield, V, T1, T2> Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

pub fn null() -> Self

pub unsafe fn from_ptr(ptr: *mut V) -> Self

Constructs a Shared from a raw tagged pointer with an arbitrary lifetime.

Safety

The alignment of V must free up sufficient low bits so that T fits.

pub unsafe fn from_raw(data: usize) -> Self

Constructs a Shared from a raw tagged pointer represented as an integer with an arbitrary lifetime.

This function constructs a Shared<'shield, V, T> from a raw tagged pointer.

Safety

This is marked unsafe because extreme caution must be taken to supply correct data and ensure the lifetime is what you expect.

pub fn into_raw(self) -> usize

Get the raw tagged pointer as an integer.

pub fn as_ptr(self) -> *mut V

Get the raw tagged pointer.

pub fn strip(self) -> Self

Remove all tags by zeroing their bits.

pub unsafe fn as_ref(self) -> Option<&'shield V>

Converts the pointer into a reference. This will panic if the tagged pointer is null.

Safety

• The pointer must either be null or point to a valid instance of V.
• You must ensure the instance of V is not borrowed mutably.

pub unsafe fn as_mut_ref(self) -> Option<&'shield mut V>

Converts the pointer into a mutable reference. This will panic if the tagged pointer is null.

Safety

• The pointer must either be null or point to a valid instance of V.
• You must ensure the instance of V is not borrowed.

pub unsafe fn as_ref_unchecked(self) -> &'shield V

Converts the pointer into a reference.

Safety

• The pointer must point to a valid instance of V.
• You must ensure the instance of V is not borrowed mutably.

pub unsafe fn as_mut_ref_unchecked(self) -> &'shield mut V

Converts the pointer into a mutable reference.

Safety

• The pointer must point to a valid instance of V.
• You must ensure the instance of V is not borrowed.

pub fn is_null(self) -> bool

Check if the tagged pointer is null.

pub fn tag_lo(self) -> T1

Get the tag in the low position.

pub fn tag_hi(self) -> T2

Get the tag in the high position.

pub fn with_tag_lo(self, tag: T1) -> Self

Set the tag in the low position.

pub fn with_tag_hi(self, tag: T2) -> Self

Set the tag in the high position.

Trait Implementations

impl<'shield, V, T1, T2> Clone for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'shield, V, T1, T2> Copy for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

impl<'shield, V, T1, T2> Debug for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

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

Formats the value using the given formatter.

impl<'shield, V, T1, T2> Eq for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

impl<'shield, V, T1, T2> PartialEq<Shared<'shield, V, T1, T2>> for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'shield, V, T1, T2> Send for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

impl<'shield, V, T1, T2> Sync for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag, 

impl<'shield, V, T1, T2> Unpin for Shared<'shield, V, T1, T2> where
    V: 'shield,
    T1: Tag,
    T2: Tag,