Struct rc_dlist_deque::dlist::Pointer

pub struct Pointer<N, S> where
    S: Selector<Node = N> + Clone,  { /* fields omitted */ }

Reference to a node, with respect to its potential membership of a list.

If the node can be a member of multiple lists, a reference to a specific one of its potential memberships. (Another way to look at this is that a pointer is a reference to a particular link within a node.)

May be kept persistently in other data structures.

May point to an element which is not currently on a list, but may not point to no element.

Holds an Rc onto the node.

Methods

impl<N, S: Selector<Node = N>> Pointer<N, S>

pub fn new(p: &Rc<N>) -> Pointer<N, S> where
    S: Default, 

Makes a pointer out of a reference to a node.

Only possible where the selector type has a default value; eg, when called as Pointer1::new, or in other situations where the relevant link in each node is identified at compile-time.

pub fn with_selector(p: &Rc<N>, selector: S) -> Pointer<N, S>

Makes a pointer, with runtime link selection

Given a reference p to a node, and selector, makes them into a pointer --- that is, a reference to the node but with respect to that specific possible list membership.

pub fn from_data(data: N, selector: S) -> Pointer<N, S>

Consumes data, and returns a reference ready for use with a list.

pub fn selector(&self) -> S

Returns the selector portion of the pointer.

pub fn ptr_eq(a: &Pointer<N, S>, b: &Pointer<N, S>) -> bool where
    S: PartialEq, 

true iff the pointers are equal.

Ie, if they both point to the same node and (with runtime link selection) have the same selector. Ie, they both refer to the same link within the same node.

pub fn cursor_eq(a: &Cursor<N, S>, b: &Cursor<N, S>) -> bool where
    S: PartialEq, 

true iff both pointers are equal, or both are null (None).

Important traits for ListIterator<N, S>

impl<N, S: Selector<Node = N>> Iterator for ListIterator<N, S> type Item = Pointer<N, S>;

pub fn iter_at(&self) -> ListIterator<N, S>

Returns an iterator starting here

The iterator will process the entry referred to by self, and subsequent entries.

pub fn get_next_prev(&self, rev: bool) -> Cursor<N, S>

Returns a cursor pointing to the next or previous item.

Methods from Deref<Target = Rc<N>>

Trait Implementations

impl<N, S: Selector<Node = N>> Clone for Pointer<N, S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, S: Selector<Node = N> + Debug> Debug for Pointer<N, S>

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

Formats the value using the given formatter.

impl<N, S: Selector<Node = N>> Deref for Pointer<N, S>

type Target = Rc<N>

The resulting type after dereferencing.

fn deref(&self) -> &Rc<N>

Dereferences the value.

impl<N, S: Selector<Node = N>> DerefMut for Pointer<N, S>

fn deref_mut(&mut self) -> &mut Rc<N>

Mutably dereferences the value.

impl<'a, N, S> From<&'a Rc<N>> for Pointer<N, S> where
    S: Default + Selector<Node = N>, 

fn from(p: &Rc<N>) -> Pointer<N, S>

Performs the conversion.

impl<N, S: Default + Selector<Node = N>> From<N> for Pointer<N, S>

fn from(data: N) -> Pointer<N, S>

Performs the conversion.

impl<N, S> From<Rc<N>> for Pointer<N, S> where
    S: Default + Selector<Node = N>, 

fn from(p: Rc<N>) -> Pointer<N, S>

Performs the conversion.

impl<N, S: Selector<Node = N> + SelectorFmt> Pointer for Pointer<N, S>

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

Formats the value using the given formatter.