Struct TraversalSpec 

pub struct TraversalSpec {
    pub name: &'static str,
    pub summary: &'static str,
    pub networkx: Option<&'static str>,
    pub params: &'static [TraversalParam],
    pub outputs: &'static [TraversalOutput],
}

One traversal.

Fields

name: &'static str

summary: &'static str

One line on what it returns.

networkx: Option<&'static str>

The NetworkX call it matches, as docs/semantics.md pins it.

params: &'static [TraversalParam]

The parameters besides the graph, in SQL’s order: the node ids first.

outputs: &'static [TraversalOutput]

Implementations

impl TraversalSpec

pub fn param(&self, name: &str) -> Option<&'static TraversalParam>

The parameter called name.

pub fn node_params(&self) -> impl Iterator<Item = &'static TraversalParam>

The parameters that take node ids, in order: each is one child plan of the traversal node.

pub fn directions(&self) -> &'static [&'static str]

The directions the traversal accepts; empty for one without a direction parameter.

pub fn weighted(&self) -> bool

Whether the traversal takes a weight.

pub fn schema(&self, id_type: &DataType) -> Schema

The output schema over a graph whose node ids are id_type.

pub fn signature(&self) -> String

hop(<graph>, seeds => [<id>, ...], n => 1, direction => 'out'): the call with every parameter at its default, for messages.

Trait Implementations

impl Debug for TraversalSpec

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

Formats the value using the given formatter.