Struct CollectSpec 

pub struct CollectSpec {
    pub alias: String,
    pub rel_type: Option<String>,
    pub direction: Direction,
    pub target_labels: Vec<String>,
    pub steps: Vec<TraversalStep>,
    pub fields: Vec<(String, String)>,
    pub nested: Vec<CollectSpec>,
    pub filter: Option<Expr>,
    pub order_by: Vec<(String, bool)>,
    pub unique: bool,
    pub skip: u64,
    pub limit: Option<u64>,
}

$collect at the root binding grain (document 19): one declared step per level, batched typed-adjacency collection, optional uniqueness and local slice. Output attaches to each returned record under alias.

Two forms: alias-based (from in the docs) resolves rel_type/ direction/target_labels from the matching where traversal alias, and projects whole records unless fields is set; label-based (label in the docs) traverses inline (direction defaults to outgoing), supports a where filter, an output-key→field projection map, and nested collects evaluated recursively on each collected record (hierarchical output).

Fields

alias: String

Output key the collected array is attached under.

rel_type: Option<String>

Relationship type filter for direct-adjacency collects.

direction: Direction

Edge direction for direct-adjacency collects.

target_labels: Vec<String>

Labels a collected record must carry (empty = any label).

steps: Vec<TraversalStep>

Alias-based (from) collects carry the full traversal path to the alias, including each level’s where predicates. Empty for label-based collects (direct adjacency).

fields: Vec<(String, String)>

(output_key, source_field) projection; empty = whole record.

nested: Vec<CollectSpec>

Nested (hierarchical) collects evaluated on each collected record.

filter: Option<Expr>

where filter evaluated on each collected record (label-based).

order_by: Vec<(String, bool)>

ORDER BY (field, desc) applied to the collected array.

unique: bool

When true, deduplicate collected records by identity.

skip: u64

Number of collected records to skip after ordering.

limit: Option<u64>

Maximum number of collected records to return.

Trait Implementations

impl Clone for CollectSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CollectSpec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CollectSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CollectSpec