Struct Path 

pub struct Path { /* private fields */ }

A graph-traversal expression — e.g. ->wrote->post, <-wrote<-user, or a multi-hop chain with an optional .field/.* accessor at the end.

A Path is a DynExpr, so it works anywhere the builder takes an expression: as a SELECT projection (Projection::aliased(path, "posts")), inside a WHERE filter, or as a SET value. With no start it is relative to the statement’s FROM table; Path::from_record anchors it to a record.

// ->wrote->post.title AS titles
let p = Path::out::<Wrote>().to::<Post>().field("title");
Post::table().project(vec![Projection::aliased(p, "titles")]);

Implementations

impl Path

pub fn out<E>() -> Path

where E: SurrealEdge,

Start an outgoing hop over edge E — ->edge.

pub fn inn<E>() -> Path

where E: SurrealEdge,

Start an incoming hop over edge E — <-edge.

pub fn both<E>() -> Path

where E: SurrealEdge,

Start a bidirectional hop over edge E — <->edge.

pub fn out_edge(edge: &'static str) -> Path

Start an outgoing hop over a raw edge name — ->edge.

pub fn in_edge(edge: &'static str) -> Path

Start an incoming hop over a raw edge name — <-edge.

pub fn both_edge(edge: &'static str) -> Path

Start a bidirectional hop over a raw edge name — <->edge.

pub fn from_record<V>(self, start: V) -> Path

where V: SurrealQL,

Anchor an existing path to a starting record literal — <record><path> (e.g. user:tobie->wrote->post). Pass a Thing.

pub fn from_expr(self, start: impl DynExpr + 'static) -> Path

Anchor an existing path to a starting expression — e.g. a RecordLink (type::record('user', $id)->wrote->post).

pub fn to<T>(self) -> Path

where T: SurrealRecord,

Constrain the destination of the most recent hop to table T — ->edge->table.

pub fn to_table(self, table: &'static str) -> Path

Constrain the destination of the most recent hop to a raw table name.

pub fn where_(self, expr: impl DynExpr + 'static) -> Path

Filter the most recent hop’s edge — ->(edge WHERE <expr>).

pub fn then_out<E>(self) -> Path

where E: SurrealEdge,

Chain another outgoing hop over edge E.

pub fn then_in<E>(self) -> Path

where E: SurrealEdge,

Chain another incoming hop over edge E.

pub fn then_both<E>(self) -> Path

where E: SurrealEdge,

Chain another bidirectional hop over edge E.

pub fn then_out_edge(self, edge: &'static str) -> Path

Chain another hop over a raw edge name, outgoing.

pub fn then_in_edge(self, edge: &'static str) -> Path

Chain another hop over a raw edge name, incoming.

pub fn recurse_all(self) -> Path

Repeat the path recursively, unbounded — @.{..}<path>. Combine with from_record to anchor the recursion at a record (person:tobie.{..}->knows->person).

pub fn recurse_up_to(self, max: u32) -> Path

Recurse up to max hops — @.{..max}<path>.

pub fn recurse_range(self, min: u32, max: u32) -> Path

Recurse between min and max hops — @.{min..max}<path>.

pub fn recurse_exact(self, n: u32) -> Path

Recurse exactly n hops — @.{n}<path>.

pub fn field(self, name: impl Into<String>) -> Path

Append a field accessor — <path>.field.

pub fn all(self) -> Path

Append the all-fields accessor — <path>.*.

pub fn contains<V>(self, value: V) -> ContainsExpr

where V: SurrealQL,

<path> CONTAINS <value> — e.g. membership test over a traversed list.

pub fn eq_expr(self, rhs: impl DynExpr + 'static) -> EqExpr

<path> = <expr>.

impl Path

pub fn and(self, other: impl DynExpr + 'static) -> AndExpr

pub fn or(self, other: impl DynExpr + 'static) -> OrExpr

Trait Implementations

impl Debug for Path

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

Formats the value using the given formatter.

impl DynExpr for Path

fn render_dyn(&self, buf: &mut String)

Append this expression’s SurrealQL to buf with all values inlined.

fn render_dyn_params( &self, buf: &mut String, params: &mut BTreeMap<String, Value>, )

Render with $param placeholders, collecting values into params. Default falls back to inline rendering; Literal nodes override this to emit $pN placeholders and collect their value.