Struct DocumentTree 

pub struct DocumentTree { /* private fields */ }

Implementations

impl DocumentTree

pub fn new(title: &str, content: &str) -> Self

Create a new document tree with a root node.

pub fn from_raw(arena: Arena<TreeNode>, root_id: NodeId) -> Self

Create a document tree from an existing arena and root ID.

This is useful for deserialization and testing.

pub fn root(&self) -> NodeId

Get the root node ID.

pub fn arena(&self) -> &Arena<TreeNode>

Get a reference to the underlying arena.

pub fn get(&self, id: NodeId) -> Option<&TreeNode>

Get a node by its ID.

Returns None if the node doesn’t exist.

pub fn get_mut(&mut self, id: NodeId) -> Option<&mut TreeNode>

Get a mutable reference to a node by its ID.

Returns None if the node doesn’t exist.

pub fn add_child( &mut self, parent: NodeId, title: &str, content: &str, ) -> NodeId

Add a child node to the specified parent.

Returns the ID of the newly created child node.

pub fn add_child_with_pages( &mut self, parent: NodeId, title: &str, content: &str, start_page: usize, end_page: usize, ) -> NodeId

Add a child node with page boundaries.

Returns the ID of the newly created child node.

pub fn is_leaf(&self, id: NodeId) -> bool

Check if a node is a leaf (has no children).

pub fn children(&self, id: NodeId) -> Vec<NodeId>

Get the children of a node.

pub fn parent(&self, id: NodeId) -> Option<NodeId>

Get the parent of a node.

Returns None if the node is the root or doesn’t have a parent.

pub fn leaves(&self) -> Vec<NodeId>

Get all leaf nodes in the tree.

pub fn traverse(&self) -> Vec<NodeId>

Get all nodes in the tree (depth-first order).

pub fn node_count(&self) -> usize

Get the number of nodes in the tree.

pub fn set_summary(&mut self, id: NodeId, summary: &str)

Update a node’s summary.

pub fn set_content(&mut self, id: NodeId, content: &str)

Update a node’s content.

pub fn set_page_boundaries(&mut self, id: NodeId, start: usize, end: usize)

Set page boundaries for a node.

pub fn set_line_indices(&mut self, id: NodeId, start: usize, end: usize)

Set line indices for a node.

pub fn page_range(&self, id: NodeId) -> Option<(usize, usize)>

Get page range for a node.

pub fn contains_page(&self, id: NodeId, page: usize) -> bool

Check if a node contains a specific page.

pub fn set_node_id(&mut self, id: NodeId, node_id: &str)

Set the node ID (identifier string).

pub fn set_physical_index(&mut self, id: NodeId, index: &str)

Set the physical index marker.

pub fn set_token_count(&mut self, id: NodeId, count: usize)

Update token count for a node.

pub fn to_structure_json(&self, doc_name: &str) -> DocumentStructure

Export the tree structure to JSON format (PageIndex compatible).

pub async fn generate_summaries<F, Fut>( &mut self, summarizer: F, ) -> Result<(), Box<dyn Error + Send + Sync>>

where F: FnMut(String) -> Fut, Fut: Future<Output = Result<String, Box<dyn Error + Send + Sync>>>,

Generate summaries for all nodes using the provided summarizer.

This method traverses the tree and generates summaries for each node that has content.

Trait Implementations

impl Clone for DocumentTree

fn clone(&self) -> DocumentTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentTree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentTree

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentTree

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.