Struct Cursor 

pub struct Cursor<'a, K, P, Tag = DefaultObjectTag, S = NonTrackingSize, O = DefaultWavlTreeObserver<<P as PtrTraits>::Target>>
where
    P: PtrTraits,
    P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>,
    K: Ord,
    S: SizeTracker,
    O: WavlTreeObserver<Target = P::Target>,
{ /* private fields */ }

A read-only cursor positioned in a WavlTree.

Implementations

impl<'a, K, P, Tag, S, O> Cursor<'a, K, P, Tag, S, O>

where P: PtrTraits, P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>, K: Ord, S: SizeTracker, O: WavlTreeObserver<Target = P::Target>,

pub fn get(&self) -> Option<&'a P::Target>

Returns a reference to the current element, or None if the cursor is at the sentinel.

pub fn is_valid(&self) -> bool

Returns true if the cursor is positioned at a valid element (not the sentinel).

pub fn left(&self) -> Self

Returns a cursor positioned at the left child of the current element. If the current element is the sentinel, returns a cursor at the sentinel.

pub fn right(&self) -> Self

Returns a cursor positioned at the right child of the current element.

pub fn parent(&self) -> Self

Returns a cursor positioned at the parent of the current element.

pub fn as_raw_ptr(&self) -> *mut P::Target

Returns the raw pointer to the current element. This may be a sentinel pointer if the cursor is at the sentinel.

Trait Implementations

impl<'a, K, P, Tag, S, O> Clone for Cursor<'a, K, P, Tag, S, O>

where P: PtrTraits, P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>, K: Ord, S: SizeTracker, O: WavlTreeObserver<Target = P::Target>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, K, P, Tag, S, O> Debug for Cursor<'a, K, P, Tag, S, O>

where P: PtrTraits, P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>, K: Ord, S: SizeTracker, O: WavlTreeObserver<Target = P::Target>,

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

Formats the value using the given formatter.

impl<'a, K, P, Tag, S, O> PartialEq for Cursor<'a, K, P, Tag, S, O>

where P: PtrTraits, P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>, K: Ord, S: SizeTracker, O: WavlTreeObserver<Target = P::Target>,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, K, P, Tag, S, O> Copy for Cursor<'a, K, P, Tag, S, O>

where P: PtrTraits, P::Target: WavlTreeContainable<P::Target, Tag> + WavlTreeKeyable<K>, K: Ord, S: SizeTracker, O: WavlTreeObserver<Target = P::Target>,