Struct pin_list::InitializedNode

#[repr(transparent)]
pub struct InitializedNode<'node, T: ?Sized + Types> { /* private fields */ }

A Node which is guaranteed to be initialized, accessed by Node::initialized and Node::initialized_mut.

You can never create and will never interact with owned or &mut instances of this type — it is accessed solely as &InitializedNode<'_, T> or Pin<&mut InitializedNode<'_, T>>.

Implementations

impl<'node, T: ?Sized + Types> InitializedNode<'node, T>

pub fn unprotected(&self) -> &T::Unprotected

Get a shared reference to the unprotected data of this node.

pub fn protected<'list>(
    &self,
    list: &'list PinList<T>
) -> Option<&'list T::Protected>

Get a shared reference to the protected data of this node.

Returns None if the node is in its removed state (has been removed from the list).

Panics

Panics if the given list is a different one than this node was registered with.

pub fn protected_mut<'list>(
    &self,
    list: &'list mut PinList<T>
) -> Option<&'list mut T::Protected>

Get a unique reference to the protected data of this node.

Returns None if the node is in its removed state (has been removed from the list).

Panics

Panics if the given list is a different one than this node was registered with.

pub fn cursor<'list>(&self, list: &'list PinList<T>) -> Option<Cursor<'list, T>>

Obtain a shared cursor pointing to this node.

Returns None if the node was in its removed state (it was removed from the list).

Panics

Panics if the given list is a different one than this node was registered with.

pub fn cursor_mut<'list>(
    &self,
    list: &'list mut PinList<T>
) -> Option<CursorMut<'list, T>>

Obtain a unique cursor pointing to this node.

Returns None if the node was in its removed state (it was removed from the list).

Panics

Panics if the given list is a different one than this node was registered with.

pub fn unlink(
    self: Pin<&'node mut Self>,
    list: &mut PinList<T>
) -> Result<(T::Protected, T::Unprotected), Pin<&'node mut Self>>

Remove this node from its containing list and take its data, leaving the node in its initial state.

Errors

Fails if the node is in its removed state — use take_removed to handle that case, or call reset instead.

Panics

Panics if the given list is a different one than this node was registered with.

pub fn take_removed(
    self: Pin<&'node mut Self>,
    list: &PinList<T>
) -> Result<(T::Removed, T::Unprotected), Pin<&'node mut Self>>

Take the data out of this node if it has been removed from the list, leaving the node in its initial state.

Errors

Errors if the node was in its “linked” state (it was still part of the list) — use unlink in this case, or call reset instead.

Panics

Panics if the given list is a different one than this node was registered with.

pub unsafe fn take_removed_unchecked(
    self: Pin<&'node mut Self>
) -> (T::Removed, T::Unprotected)

Take the data out of this node, assuming that it has been removed from the list, leaving the node in its initial state.

In contrast to take_removed, this does not require access to the PinList.

Safety

The node must not be in its linked state.

pub fn reset(
    self: Pin<&'node mut Self>,
    list: &mut PinList<T>
) -> (NodeData<T>, T::Unprotected)

Reset the node back to its initial state.

If the node is linked, this will unlink it, and then the node will be moved to the initial state.

This can be thought of as a combination of unlink and take_removed.

Panics

Panics if the given list is a different one than this node was registered with.

Methods from Deref<Target = 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 InitializedNode<'_, T> where
    T::Unprotected: Debug, 

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

Formats the value using the given formatter.

impl<T: ?Sized + Types> Deref for InitializedNode<'_, T>

type Target = Node<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.