NodePtr

Struct NodePtr 

Source
pub struct NodePtr<V: Variant> { /* private fields */ }
Expand description

A wrapper around a node pointer.

Implementations§

Source§

impl<V: Variant> NodePtr<V>

Source

pub fn new(ptr: *const Node<V>) -> Self

Creates a new node pointer by wrapping the given ptr.

Source

pub fn is_valid_for<M, P>(self, collection: &SelfRefCol<V, M, P>) -> bool
where M: MemoryPolicy<V>, P: PinnedVec<Node<V>>,

Returns true if:

  • collection owns this NodePtr, and
  • the node, or corresponding element of the collection, that this pointer is pointing at is still active;

false otherwise.

It is safe to use the unsafe methods of NodePtr if is_valid_for(col) returns true where col is the collection that the pointer is created from.

Source

pub unsafe fn ptr(self) -> *const Node<V>

Returns the const raw pointer to the node.

§SAFETY

This method is unsafe as NodePtr implements Send and Sync.

It is safe dereference the received pointer if we know that is_valid_for(col) would return true where col is the collection that this pointer is created from.

Source

pub unsafe fn ptr_mut(self) -> *mut Node<V>

Returns the mutable raw pointer to the node.

§SAFETY

This method is unsafe as NodePtr implements Send and Sync.

It is safe dereference the received pointer if we know that is_valid_for(col) would return true where col is the collection that this pointer is created from.

Source

pub unsafe fn node<'a>(self) -> &'a Node<V>

Returns a reference to the node.

§Safety

It is safe to directly access the underlying node if we know that is_valid_for(col) would return true where col is the collection that this pointer is created from.

Source

pub unsafe fn node_mut<'a>(self) -> &'a mut Node<V>

Returns a mutable reference to the node.

§Safety

It is safe to directly access the underlying node if we know that is_valid_for(col) would return true where col is the collection that this pointer is created from.

Trait Implementations§

Source§

impl<V: Variant> Clone for NodePtr<V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<V: Variant> Debug for NodePtr<V>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<V: Variant> PartialEq for NodePtr<V>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<V: Variant> Copy for NodePtr<V>

Source§

impl<V: Variant> Send for NodePtr<V>
where V::Item: Send,

Source§

impl<V: Variant> Sync for NodePtr<V>
where V::Item: Sync,

Auto Trait Implementations§

§

impl<V> Freeze for NodePtr<V>

§

impl<V> RefUnwindSafe for NodePtr<V>

§

impl<V> Unpin for NodePtr<V>

§

impl<V> UnwindSafe for NodePtr<V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SoM<T> for T

Source§

fn get_ref(&self) -> &T

Returns a reference to self.
Source§

fn get_mut(&mut self) -> &mut T

Returns a mutable reference to self.
Source§

impl<T> SoR<T> for T

Source§

fn get_ref(&self) -> &T

Returns a reference to self.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.