Struct CompiledQuery

pub struct CompiledQuery {
    pub response: Response,
    pub scope: CompiledScope,
    pub threshold: Threshold,
    pub triggers: Vec<CompiledTrigger>,
    pub id: Option<String>,
}

Represents a compiled query which is ready to scan (compiled) documents (CompiledDocument).

For more information about each of these fields, please see the Query documentation.

Fields

response: Response

scope: CompiledScope

threshold: Threshold

triggers: Vec<CompiledTrigger>

id: Option<String>

Trait Implementations

impl Clone for CompiledQuery

fn clone(&self) -> CompiledQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompilableTo<CompiledQuery> for Query

fn compile(&self) -> Result<CompiledQuery, Issue>

Compiles the Query into a CompiledQuery. Like all compilation operations, this is expensive.

impl From<CompiledQuery> for CompiledQueryGroup

fn from(query: CompiledQuery) -> CompiledQueryGroup

This helper function creates a CompiledQueryGroup for single queries, enabling multithreading support for single queries without any significant ‘hacks.’

impl Scanner for CompiledQuery

fn scan_single(&self, document: &CompiledDocument) -> OutputBatch

Scan a single document and return the output.

fn scan_batch(&self, documents: &CompiledDocumentBatch) -> OutputBatch

Scan a batch of documents and return the output. This function is singlethreaded and often not very performant.

fn scan_concurrently(&self, threads: u8) -> AsyncScanInterface

Launch a ‘scan engine’ and create an asynchronous and concurrent scanning system. In most cases, this is what you’ll want to use.