Struct Scan 

pub struct Scan {
    pub coll: String,
    pub as_of: Option<u64>,
    pub valid_as_of: Option<String>,
    pub search: Option<String>,
    pub trace: Option<String>,
    pub trace_reverse: bool,
    pub traverse: Option<String>,
    pub trace_limit: usize,
}

One relation to read, and the qualifiers that shape it.

Every field is a question the store can answer directly. There is no rendering step and nothing to escape — SEARCH 'o''brien' was a quoting problem when this was a string, and is not one now.

Fields

coll: String

The collection name.

as_of: Option<u64>

AS OF SYSTEM TIME <seq> — system time, a sequence.

valid_as_of: Option<String>

VALID AS OF '<date>' — application time, a date string.

search: Option<String>

SEARCH '<text>' — substring over the document’s rendered fields.

trace: Option<String>

TRACE <edge> [REVERSE] — replace each row with its causal chain.

trace_reverse: bool

Walk effects rather than causes.

traverse: Option<String>

TRAVERSE <rel> — replace each row with its one-hop neighbours.

trace_limit: usize

Chain length cap for TRACE.

Explicit rather than defaulted at the call site. NQL took this from the query’s LIMIT and fell back to 1000 — which silently conflated “how many rows do I want back” with “how deep may a causal chain go”, two unrelated numbers. They are separate here, and a truncated chain is a thing the caller chose.

Implementations

impl Scan

pub fn new(coll: impl Into<String>) -> Scan

pub fn is_plain(&self) -> bool

True when this scan asks for anything beyond the live collection.

Trait Implementations

impl Clone for Scan

fn clone(&self) -> Scan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scan

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

Formats the value using the given formatter.

impl Default for Scan

fn default() -> Scan

Returns the “default value” for a type.