Struct GraphQuery 

pub struct GraphQuery {
    pub start_nodes: Vec<String>,
    pub direction: TraversalDirection,
    pub max_depth: usize,
    pub edge_types: Option<Vec<EdgeType>>,
    pub max_results: usize,
    pub language_filter: Option<String>,
    pub granularity_filter: Option<String>,
    pub include_start: bool,
}

A query against the graph

Fields

start_nodes: Vec<String>

Starting chunk IDs

direction: TraversalDirection

Direction of traversal

max_depth: usize

Maximum depth to traverse

edge_types: Option<Vec<EdgeType>>

Edge types to follow

max_results: usize

Maximum nodes to return

language_filter: Option<String>

Filter by language

granularity_filter: Option<String>

Filter by granularity

include_start: bool

Include the starting nodes in results

Implementations

impl GraphQuery

pub fn new(start_nodes: Vec<String>) -> Self

Create a new query starting from given chunks

pub fn dependencies(chunk_id: impl Into<String>) -> Self

Query dependencies (things this chunk needs)

pub fn dependents(chunk_id: impl Into<String>) -> Self

Query dependents (things that need this chunk)

pub fn with_direction(self, direction: TraversalDirection) -> Self

Set traversal direction

pub fn with_depth(self, depth: usize) -> Self

Set maximum depth

pub fn with_edge_types(self, types: Vec<EdgeType>) -> Self

Filter by edge types

pub fn strong_only(self) -> Self

Only follow strong dependencies

pub fn with_limit(self, limit: usize) -> Self

Set maximum results

pub fn with_language(self, language: impl Into<String>) -> Self

Filter by language

pub fn include_start(self, include: bool) -> Self

Whether to include start nodes

pub fn should_follow_edge(&self, edge_type: EdgeType) -> bool

Check if an edge type should be followed

Trait Implementations

impl Clone for GraphQuery

fn clone(&self) -> GraphQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQuery

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

Formats the value using the given formatter.

impl Default for GraphQuery

fn default() -> GraphQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.