Skip to main content

QueryOptions

Struct QueryOptions 

Source
pub struct QueryOptions<'a> {
    pub limit: Option<usize>,
    pub cursor: Option<&'a str>,
    pub provider: Option<&'a dyn EmbeddingProvider>,
    pub in_memory: bool,
    pub bare: bool,
    pub unknown_names: Option<UnknownNames>,
    pub vocabulary: Option<&'a VocabularyCache>,
    pub now_ms: Option<i64>,
}
Expand description

query’s options.

Fields§

§limit: Option<usize>

The page cap (default 50).

§cursor: Option<&'a str>

Resume after a truncated page’s cursor.

§provider: Option<&'a dyn EmbeddingProvider>

The provider behind semantic(...); None → semantic_unavailable when the query names a phrase.

§in_memory: bool

Force the pure in-memory engine (skip the tier-3 pushdown planner). The default plans; the differential gate runs both and compares.

§bare: bool

bare: true (§1.4, 4.2): every hit is its projection only — the automatic id/path envelope members are stripped when the result is shaped, AFTER paging and distinct (identity is kept internally: the keyset cursor and the dedup key read the envelope). Needs a select (without a projection a hit is only its envelope) and is refused with values (already the bare-values form); a projected id/path is the row’s intrinsic, kept as any projected key is.

§unknown_names: Option<UnknownNames>

What a tier-3 name on an open kind does (spec/surface §1.5, 4.6; a tier-3 name on links is filter_invalid either way): Hint records it in hints and runs the query — the default of the source entry (query, every read); Refuse fails with filter_invalid before any row is read — the default of the AST entry (query_ast), whose caller is the write selector compiler, where a name no row carries would select every row. None takes the entry’s default.

§vocabulary: Option<&'a VocabularyCache>

The vocabulary cache of the store (§1.5 “Caching”), kept by the Surface beside its store; None judges with a cache of the run’s own.

§now_ms: Option<i64>

The instant the named points of date() resolve against (spec/surface §1.3, 4.8): the host clock, UTC, in milliseconds — the Surface passes the clock it stamps commits with (pinned by OMGBASE_SPEC_CLOCK); None reads the wall clock. One instant per run: the fold and the context share it.

Trait Implementations§

Source§

impl<'a> Clone for QueryOptions<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for QueryOptions<'a>

Source§

impl<'a> Default for QueryOptions<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for QueryOptions<'a>

§

impl<'a> !Send for QueryOptions<'a>

§

impl<'a> !Sync for QueryOptions<'a>

§

impl<'a> !UnwindSafe for QueryOptions<'a>

§

impl<'a> Freeze for QueryOptions<'a>

§

impl<'a> Unpin for QueryOptions<'a>

§

impl<'a> UnsafeUnpin for QueryOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.