Struct linked_syntax_tree::Cursor

pub struct Cursor<'a, T> { /* private fields */ }

Roughly matches std::collections::linked_list::Cursor.

Implementations

impl<T: Debug> Cursor<'_, T>

pub fn root(&self) -> Option<&T>

Provides a reference to the root element.

pub fn current(&self) -> Option<&T>

Get the current element.

pub fn move_preceding(&mut self)

Moves the cursor to the preceding element.

If there is no preceding element the cursor is not moved.

pub fn move_next(&mut self)

Moves the cursor to the next element.

pub fn move_child(&mut self)

Moves the cursor to the child element.

pub fn move_parent(&mut self) -> bool

Moves the cursor through preceding elements until reaching a parent or the root element.

Returns true if the cursor was moved to a parent or false if it was moved to the root element.

pub fn move_successor(&mut self) -> bool

Moves the cursor to the successor element or the root element if a successor is not present.

Returns true if the cursor was moved to a successor or false if it was moved to the root element.

pub fn move_predecessor(&mut self) -> bool

Moves the cursor to the predecessor element or the root element if a predecessor is not present.

Returns true if the cursor was moved to a predecessor or false if it was moved to the root element.

pub fn peek_next(&self) -> Option<&T>

Returns a reference to the next element.

pub fn peek_parent(&self) -> Option<&T>

Returns a reference to the parent element.

Wrapper around self.peek_preceding().and_then(Preceding::parent).

pub fn peek_previous(&self) -> Option<&T>

Returns a reference to the previous element.

Wrapper around self.peek_preceding().and_then(Preceding::previous) .

pub fn peek_preceding(&self) -> Option<Preceding<&T>>

Returns a reference to the preceding element.

pub fn peek_child(&self) -> Option<&T>

Returns a reference to the child element.

Trait Implementations

impl<'a, T> Clone for Cursor<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Cursor<'a, T>

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

Formats the value using the given formatter.