Struct GraphNeighborhood 

pub struct GraphNeighborhood {
    pub root: GraphNodeRef,
    pub hops: usize,
    pub nodes_in_subgraph: usize,
    pub edges: Vec<GraphHopEdge>,
    pub truncated: bool,
    pub db_nodes: usize,
    pub db_edges: usize,
}

Result of a neighborhood query around one node.

Fields

root: GraphNodeRef

Resolved seed node.

hops: usize

Requested hop depth.

nodes_in_subgraph: usize

Unique nodes in the subgraph including the root.

edges: Vec<GraphHopEdge>

Edges returned (may be capped by GraphOptions::max_edges).

truncated: bool

True when max_edges truncated the expansion.

db_nodes: usize

Total nodes in the database (context).

db_edges: usize

Total edges in the database (context).

Implementations

impl GraphNeighborhood

pub fn to_ascii(&self) -> String

Human/agent-readable ASCII (tree-style for hop 1+, indented by hop).

Trait Implementations

impl Clone for GraphNeighborhood

fn clone(&self) -> GraphNeighborhood

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphNeighborhood

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphNeighborhood

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphNeighborhood

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

where __S: Serializer,

Serialize this value into the given Serde serializer.