1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
// Copyright (c) 2026 Austin Han <austinhan1024@gmail.com>
//
// This file is part of RocksGraph.
//
// RocksGraph is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// RocksGraph is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with RocksGraph. If not, see <https://www.gnu.org/licenses/>.
use std::rc::Rc;
use smallvec::SmallVec;
use crate::types::PIPELINE_PRODUCE_SIZE;
use crate::{
engine::{
context::GraphCtx,
traverser::Traverser,
volcano::steps::traits::{CoreStep, ExplainNode, StepRef},
},
types::{
error::StoreError,
gvalue::{GValue, Primitive},
},
};
/// Extracts the rank of the current element. Edge-only — rank is the structural
/// multi-edge discriminator (`design_multiple_edges.md`); vertices have no rank.
/// A vertex traverser reaching this step is a misuse, not a type that's silently
/// passed through — it errors rather than emitting a wrong-shaped value.
#[derive(Debug, Default)]
pub struct RankStep {
upstream: Option<StepRef>,
track_path: bool,
}
impl RankStep {
pub fn new(track_path: bool) -> Self {
Self { upstream: None, track_path }
}
}
impl CoreStep for RankStep {
fn add_upper(&mut self, upstream: StepRef) {
self.upstream = Some(upstream);
}
fn produce(
&mut self,
ctx: &mut dyn GraphCtx,
) -> Result<Option<SmallVec<[Rc<Traverser>; PIPELINE_PRODUCE_SIZE]>>, StoreError> {
let Some(upstream) = self.upstream.as_ref() else {
return Ok(None);
};
let mut batch = SmallVec::with_capacity(PIPELINE_PRODUCE_SIZE);
while batch.len() < PIPELINE_PRODUCE_SIZE {
let Some(t) = upstream.next(ctx)? else { break };
let rank_value = match &t.value {
GValue::Edge(ek) => GValue::Scalar(Primitive::UInt16(ek.rank)),
GValue::Vertex(_) => {
return Err(StoreError::UnexpectedDataType(
"rank() is edge-only — vertices have no rank".to_string(),
));
}
other => {
return Err(StoreError::UnexpectedDataType(format!("rank() expects an Edge, got {:?}", other)));
}
};
batch.push(Traverser::new_rc_conditional(rank_value, &t, self.track_path));
}
if batch.is_empty() {
Ok(None)
} else {
Ok(Some(batch))
}
}
fn reset(&mut self) {
if let Some(up) = &self.upstream {
up.reset();
}
}
fn upper(&self) -> Option<StepRef> {
self.upstream.clone()
}
fn explain(&self) -> ExplainNode {
ExplainNode::new("RankStep")
}
}