Struct SafeCursor

#[repr(transparent)]
pub struct SafeCursor<R, E: ContentTraits, I: TreeMetrics<E>, const IE: usize = DEFAULT_IE, const LE: usize = DEFAULT_LE> {
    pub inner: UnsafeCursor<E, I, IE, LE>,
    /* private fields */
}

Fields

inner: UnsafeCursor<E, I, IE, LE>

Implementations

impl<'a, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> SafeCursor<&'a ContentTreeRaw<E, I, IE, LE>, E, I, IE, LE>

This file provides the safe implementation methods for cursors.

pub unsafe fn unchecked_from_raw( _tree: &'a ContentTreeRaw<E, I, IE, LE>, cursor: UnsafeCursor<E, I, IE, LE>, ) -> Self

impl<R, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> SafeCursor<R, E, I, IE, LE>

pub fn count_pos_raw<Out, F, G, H>( &self, offset_to_num: F, entry_len: G, entry_len_at: H, ) -> Out

where Out: AddAssign + Default, F: Fn(I::Value) -> Out, G: Fn(&E) -> Out, H: Fn(&E, usize) -> Out,

impl<'a, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> SafeCursor<&'a mut ContentTreeRaw<E, I, IE, LE>, E, I, IE, LE>

pub unsafe fn unchecked_from_raw( _tree: &mut Pin<Box<ContentTreeRaw<E, I, IE, LE>>>, cursor: UnsafeCursor<E, I, IE, LE>, ) -> Self

pub fn insert_notify<F>(&mut self, new_entry: E, notify: F)

where F: FnMut(E, NonNull<NodeLeaf<E, I, IE, LE>>),

pub fn insert(&mut self, new_entry: E)

pub fn replace_range_notify<N>(&mut self, new_entry: E, notify: N)

where N: FnMut(E, NonNull<NodeLeaf<E, I, IE, LE>>),

pub fn replace_range(&mut self, new_entry: E)

pub fn delete_notify<F>(&mut self, del_items: usize, notify: F)

where F: FnMut(E, NonNull<NodeLeaf<E, I, IE, LE>>),

pub fn delete(&mut self, del_items: usize)

pub fn replace_entry(&mut self, items: &[E])

Replace the current entry with the items passed via items[]. Items.len must be <= 3. The cursor offset is ignored. This is a fancy method - use sparingly.

pub fn replace_entry_simple(&mut self, new_item: E)

pub fn mutate_single_entry_notify<MapFn, R, N>( &mut self, replace_max: usize, notify: N, map_fn: MapFn, ) -> (usize, R)

where N: FnMut(E, NonNull<NodeLeaf<E, I, IE, LE>>), MapFn: FnOnce(&mut E) -> R,

Mutate a single entry in-place. The entry to be modified is whatever is at this cursor, and up to replace_max size.

The function will be modified by the (passed) map_fn.

Returns a tuple of (actual length replaced, map_fn return value).

impl<R, E: ContentTraits + ContentLength, I: FindContent<E>, const IE: usize, const LE: usize> SafeCursor<R, E, I, IE, LE>

pub fn count_content_pos(&self) -> usize

impl<R, E: ContentTraits, I: FindOffset<E>, const IE: usize, const LE: usize> SafeCursor<R, E, I, IE, LE>

pub fn count_offset_pos(&self) -> usize

impl<R, E: ContentTraits + Searchable, I: TreeMetrics<E>, const IE: usize, const LE: usize> SafeCursor<R, E, I, IE, LE>

pub fn get_item(&self) -> Option<E::Item>

Trait Implementations

impl<R: Clone, E: Clone + ContentTraits, I: Clone + TreeMetrics<E>, const IE: usize, const LE: usize> Clone for SafeCursor<R, E, I, IE, LE>

fn clone(&self) -> SafeCursor<R, E, I, IE, LE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug, E: Debug + ContentTraits, I: Debug + TreeMetrics<E>, const IE: usize, const LE: usize> Debug for SafeCursor<R, E, I, IE, LE>

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

Formats the value using the given formatter.

impl<R, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> From<SafeCursor<R, E, I, IE, LE>> for UnsafeCursor<E, I, IE, LE>

fn from(c: SafeCursor<R, E, I, IE, LE>) -> Self

Converts to this type from the input type.

impl<R, E: ContentTraits + Eq, I: TreeMetrics<E>, const IE: usize, const LE: usize> Ord for SafeCursor<R, E, I, IE, LE>

NOTE: This comparator will panic when cursors from different range trees are compared.

Also beware: A cursor pointing to the end of a leaf entry will be considered less than a cursor pointing to the subsequent entry in the next leaf.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<R, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> PartialEq for SafeCursor<R, E, I, IE, LE>

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<R, E: ContentTraits + Eq, I: TreeMetrics<E>, const IE: usize, const LE: usize> PartialOrd for SafeCursor<R, E, I, IE, LE>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R, E: ContentTraits, I: TreeMetrics<E>, const IE: usize, const LE: usize> Eq for SafeCursor<R, E, I, IE, LE>