Struct DocumentGraph 

pub struct DocumentGraph {
    pub nodes: HashMap<Uuid, DocumentNode>,
    pub document_info: DocumentInfo,
    pub structural_profile: StructuralProfile,
}

Fields

nodes: HashMap<Uuid, DocumentNode>

document_info: DocumentInfo

structural_profile: StructuralProfile

Implementations

impl DocumentGraph

pub fn compute_structural_profile(&mut self)

Compute structural profile analytics for the entire graph

impl DocumentGraph

pub fn new_with_root(root_id: Uuid) -> DocumentGraph

Create a new graph with a deterministic root ID.

pub fn new() -> DocumentGraph

Create a new graph with a random UUIDv4 root ID (legacy).

pub fn max_depth(&self) -> u32

pub fn save_to_json(&self, path: &str) -> Result<(), Error>

pub fn to_sorted_graph(&self) -> SortedDocumentGraph

pub fn compute_breadcrumbs(&mut self)

Compute breadcrumbs for all nodes by walking the tree top-down. Sections contribute their text to the trail. Non-section nodes inherit their parent’s breadcrumbs without adding to them. If document metadata has a title, it becomes the first breadcrumb.

pub fn _analyze_subtree( &self, root_node_id: Uuid, ) -> Option<GraphAnalyticsResult>

Analyze any subtree starting from given node

impl DocumentGraph

pub fn to_sequential_format(&self) -> SequentialDocument

pub fn to_flat_format(&self) -> FlatDocument

pub fn save_with_format(&self, path: &str, format: &str) -> Result<(), Error>

Trait Implementations

impl Clone for DocumentGraph

fn clone(&self) -> DocumentGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentGraph

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

Formats the value using the given formatter.

impl Default for DocumentGraph

fn default() -> DocumentGraph

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentGraph

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocumentGraph, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentGraph

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

where __S: Serializer,

Serialize this value into the given Serde serializer.