Struct pin_list::Node

pub struct Node<T: ?Sized> where
    T: Types,  { /* private fields */ }

A node in a PinList.

This type is a state machine between three states:

1. Initial: The initial state; the node is not registered in any list. This is the only state that can be dropped without aborting the process.
2. Linked: The node has been linked into a PinList. It holds a Protected and an Unprotected, of which the former can only be accessed when access to the PinList can be proven. Dropping a node in this state will abort.
3. Removed: The node has been removed from a PinList. It holds a Removed and an Unprotected. Similar to the “linked” state, proof of access to the PinList is required for most operations. Dropping a node in this state will abort.

Implementations

impl<T: ?Sized> Node<T> where
    <T as ConstFnBounds>::Type: Types, 

pub const fn new() -> Self

Create a new node in its initial state.

You can move this node into other states by functions like PinList::push_front.

impl<T: ?Sized + Types> Node<T>

pub fn is_initial(&self) -> bool

Check whether the node is in its initial state.

pub fn insert_before(
    self: Pin<&mut Self>,
    cursor: &mut CursorMut<'_, T>,
    protected: T::Protected,
    unprotected: T::Unprotected
) -> Pin<&mut InitializedNode<'_, T>>

Insert this node into the linked list before the given cursor.

Panics

Panics if the node is not in its initial state.

pub fn insert_after(
    self: Pin<&mut Self>,
    cursor: &mut CursorMut<'_, T>,
    protected: T::Protected,
    unprotected: T::Unprotected
) -> Pin<&mut InitializedNode<'_, T>>

Insert this node into the linked list after the given cursor.

Panics

Panics if the node is not in its initial state.

pub fn initialized(&self) -> Option<&InitializedNode<'_, T>>

Borrow the node, if it is initialized (linked or removed).

Returns None if the node is in the initial state.

pub fn initialized_mut(
    self: Pin<&mut Self>
) -> Option<Pin<&mut InitializedNode<'_, T>>>

Borrow uniquely the node, if it is initialized (linked or removed).

Returns None if the node is in the initial state.

Trait Implementations

impl<T: ?Sized + Types> Debug for Node<T> where
    T::Unprotected: Debug, 

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for Node<T> where
    T: Types, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Types> Send for Node<T> where
    T::Id: Send,
    T::Protected: Send,
    T::Removed: Send,
    T::Unprotected: Send,
    T::Unprotected: Sync, 

impl<T: ?Sized + Types> Sync for Node<T> where
    T::Id: Sync,
    T::Unprotected: Sync, 

impl<'__pin, T: ?Sized> Unpin for Node<T> where
    __Origin<'__pin, T>: Unpin,
    T: Types,