Struct content_tree::UnsafeCursor

pub struct UnsafeCursor<E: ContentTraits, I: TreeIndex<E>, const IE: usize, const LE: usize> {
    pub offset: usize,
    // some fields omitted
}

A cursor into some location in a range tree.

Note the state of a cursor is weird in two situations:

• When a cursor points to a location in between two entries, the cursor could either point to the end of the first entry or the start of the subsequent entry.
• When a tree is empty, the cursor points past the end of the tree.

Safety: This is unsafe because there’s no associated lifetime on a cursor (its ’static).

The caller must ensure any reads and mutations through an UnsafeCursor are valid WRT the mutability and lifetime of the implicitly referenced content tree. Use Cursor and MutCursor.

Fields

offset: usize

Implementations

impl<E: ContentTraits, I: TreeIndex<E>, const IE: usize, const LE: usize> UnsafeCursor<E, I, IE, LE>

pub fn traverse_forward(&mut self) -> bool

Internal method for prev_entry and next_entry when we need to move laterally. This moves the cursor to the next / prev node in the tree, with no regard for the current position.

Returns true if the move was successful, or false if we’re at the first / last item in the tree.

pub fn traverse_backwards(&mut self) -> bool

pub fn prev_entry_marker(&mut self, marker: Option<&mut I::IndexUpdate>) -> bool

Move back to the previous entry. Returns true if it exists, otherwise returns false if we’re at the start of the doc already.

pub fn prev_entry(&mut self) -> bool

pub fn next_entry_marker(&mut self, marker: Option<&mut I::IndexUpdate>) -> bool

Go to the next entry marker and update the (optional) flush marker. Returns true if successful, or false if we’ve reached the end of the document.

pub fn next_entry(&mut self) -> bool

pub unsafe fn count_pos(&self) -> I::IndexValue

pub fn get_raw_entry(&self) -> E

Note this ignores the cursor’s offset.

pub fn try_get_raw_entry(&self) -> Option<E>

pub fn get_raw_entry_mut(&mut self) -> &mut E

pub fn roll_to_next_entry(&mut self) -> bool

This is a terrible name. This method modifies a cursor at the end of an entry to be a cursor to the start of the next entry - potentially in the following leaf.

Returns false if the resulting cursor location points past the end of the tree.

pub fn next(&mut self) -> bool

pub fn move_forward_by(
    &mut self,
    amt: usize,
    marker: Option<&mut I::IndexUpdate>
)

pub fn move_back_by(&mut self, amt: usize, marker: Option<&mut I::IndexUpdate>)

pub fn compress_node(&mut self)

This helper method attempts to minimize the size of the leaf around the cursor using append() methods, when possible.

pub fn check(&self)

impl<E: ContentTraits + Searchable, I: TreeIndex<E>, const IE: usize, const LE: usize> UnsafeCursor<E, I, IE, LE>

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

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

pub unsafe fn count_content_pos(&self) -> usize

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

pub unsafe fn count_offset_pos(&self) -> usize

Trait Implementations

impl<E: Clone + ContentTraits, I: Clone + TreeIndex<E>, const IE: usize, const LE: usize> Clone for UnsafeCursor<E, I, IE, LE>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + ContentTraits, I: Debug + TreeIndex<E>, const IE: usize, const LE: usize> Debug for UnsafeCursor<E, I, IE, LE>

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

Formats the value using the given formatter.

impl<E: ContentTraits + Eq, I: TreeIndex<E>, const IE: usize, const LE: usize> Ord for UnsafeCursor<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 an entry will be considered less than a cursor pointing to the subsequent entry.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<E: PartialEq + ContentTraits, I: PartialEq + TreeIndex<E>, const IE: usize, const LE: usize> PartialEq<UnsafeCursor<E, I, IE, LE>> for UnsafeCursor<E, I, IE, LE>

fn eq(&self, other: &UnsafeCursor<E, I, IE, LE>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UnsafeCursor<E, I, IE, LE>) -> bool

This method tests for !=.

impl<E: ContentTraits + Eq, I: TreeIndex<E>, const IE: usize, const LE: usize> PartialOrd<UnsafeCursor<E, I, IE, LE>> for UnsafeCursor<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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<E: Eq + ContentTraits, I: Eq + TreeIndex<E>, const IE: usize, const LE: usize> Eq for UnsafeCursor<E, I, IE, LE>

impl<E: ContentTraits, I: TreeIndex<E>, const IE: usize, const LE: usize> StructuralEq for UnsafeCursor<E, I, IE, LE>

impl<E: ContentTraits, I: TreeIndex<E>, const IE: usize, const LE: usize> StructuralPartialEq for UnsafeCursor<E, I, IE, LE>