Struct Location 

pub struct Location<T: Clone> {
    pub cursor: Tree<T>,
    pub path: Rc<Path<T>>,
}

Represents a location (cursor) within a tree.

A location combines a cursor pointing to the current tree node and a path providing context for navigation within the overall tree structure.

Fields

cursor: Tree<T>

The current tree node being focused on.

path: Rc<Path<T>>

The path representing the context of this location within the overall tree.

Implementations

impl<T: Clone> Location<T>

pub fn new(tree: Tree<T>) -> Self

Creates a new location from a tree.

Arguments

• tree - The tree to create a location from.

Returns

A new Location instance with the given tree as cursor.

pub fn go_left(self) -> Option<Self>

Moves the cursor to the left sibling.

Returns

• Some(Location) - If there is a left sibling.
• None - If there is no left sibling or the location is at the top.

pub fn go_right(self) -> Option<Self>

Moves the cursor to the right sibling.

Returns

• Some(Location) - If there is a right sibling.
• None - If there is no right sibling or the location is at the top.

pub fn go_up(self) -> Option<Self>

Moves the cursor to the parent node.

Returns

• Some(Location) - If there is a parent node.
• None - If the location is at the top.

pub fn go_down(self) -> Option<Self>

Moves the cursor to the first child node.

Returns

• Some(Location) - If the current node is a section with at least one child.
• None - If the current node is an item or an empty section.

pub fn get_nth(self, n: usize) -> Option<Self>

Gets the nth child of the current node.

This is equivalent to n calls to go_right().

Arguments

• n - The index of the child to navigate to.

Returns

• Some(Location) - If the child exists.
• None - If the child doesn’t exist or the current node is an item.

pub fn change(self, tree: Tree<T>) -> Self

Replaces the current node with a new tree.

Arguments

• tree - The new tree to replace the current node with.

Returns

A new location with the updated cursor.

pub fn insert_right(self, tree: Tree<T>) -> Option<Self>

Inserts a new tree to the right of the current node.

Arguments

• tree - The tree to insert.

Returns

• Some(Location) - If the insertion was successful.
• None - If the location is at the top.

pub fn insert_left(self, tree: Tree<T>) -> Option<Self>

Inserts a new tree to the left of the current node.

Arguments

• tree - The tree to insert.

Returns

• Some(Location) - If the insertion was successful.
• None - If the location is at the top.

pub fn insert_down(self, tree: Tree<T>) -> Option<Self>

Inserts a new tree as the first child of the current node.

Arguments

• tree - The tree to insert.

Returns

• Some(Location) - If the current node is a section.
• None - If the current node is an item.

pub fn delete(self) -> Option<Self>

Deletes the current node and moves the cursor to a sibling or parent.

Returns

• Some(Location) - If the deletion was successful.
• None - If the location is at the top.

Trait Implementations

impl<T: Clone + Clone> Clone for Location<T>

fn clone(&self) -> Location<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for Location<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Clone> PartialEq for Location<T>

fn eq(&self, other: &Location<T>) -> 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<T: Clone> StructuralPartialEq for Location<T>