Struct intrusive_collections::rbtree::Cursor

pub struct Cursor<'a, A: Adapter>where
    A::LinkOps: RBTreeOps,
{ /* private fields */ }

Expand description

A cursor which provides read-only access to a RBTree.

Implementations§

impl<'a, A: Adapter> Cursor<'a, A>
where A::LinkOps: RBTreeOps,

pub fn is_null(&self) -> bool

Checks if the cursor is currently pointing to the null object.

pub fn get(&self) -> Option<&'a <A::PointerOps as PointerOps>::Value>

Returns a reference to the object that the cursor is currently pointing to.

This returns None if the cursor is currently pointing to the null object.

pub fn clone_pointer(&self) -> Option<<A::PointerOps as PointerOps>::Pointer>
where <A::PointerOps as PointerOps>::Pointer: Clone,

Clones and returns the pointer that points to the element that the cursor is referencing.

This returns None if the cursor is currently pointing to the null object.

pub fn move_next(&mut self)

Moves the cursor to the next element of the RBTree.

If the cursor is pointer to the null object then this will move it to the first element of the RBTree. If it is pointing to the last element of the RBTree then this will move it to the null object.

pub fn move_prev(&mut self)

Moves the cursor to the previous element of the RBTree.

If the cursor is pointer to the null object then this will move it to the last element of the RBTree. If it is pointing to the first element of the RBTree then this will move it to the null object.

pub fn peek_next(&self) -> Cursor<'_, A>

Returns a cursor pointing to the next element of the RBTree.

If the cursor is pointer to the null object then this will return the first element of the RBTree. If it is pointing to the last element of the RBTree then this will return a null cursor.

pub fn peek_prev(&self) -> Cursor<'_, A>

Returns a cursor pointing to the previous element of the RBTree.

If the cursor is pointer to the null object then this will return the last element of the RBTree. If it is pointing to the first element of the RBTree then this will return a null cursor.

Trait Implementations§

impl<'a, A: Adapter> Clone for Cursor<'a, A>
where A::LinkOps: RBTreeOps,

fn clone(&self) -> Cursor<'a, A>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

impl<'a, A> Freeze for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: Freeze,

impl<'a, A> RefUnwindSafe for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: RefUnwindSafe, A: RefUnwindSafe,

impl<'a, A> Send for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: Send, A: Sync, <<A as Adapter>::PointerOps as PointerOps>::Value: Sync,

impl<'a, A> Sync for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: Sync, A: Sync, <<A as Adapter>::PointerOps as PointerOps>::Value: Sync,

impl<'a, A> Unpin for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: Unpin,

impl<'a, A> UnwindSafe for Cursor<'a, A>
where <<A as Adapter>::LinkOps as LinkOps>::LinkPtr: UnwindSafe + RefUnwindSafe, A: RefUnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.