Query
represents an uncompiled query. This type is
typically interstitial; it cannot perform scans, and has
little functionality apart from its ability to compile into
a CompiledQuery
.
This type is part of the public API, and therefore must
comply with the structure defined in the specification.
Represents the desired Response
of the query when
it matches Document
s. In other words, this is the
set of parameters for the Output
.
For more information, see the Response
documentation.
Represents the documents and content that the query
is applicable to. The Scope
allows users to specify
which URLs their query is applicable to, as well as
the type of content—Text
or Raw
—that should be passed
to the triggers.
For more information, see the Scope
documentation.
Represents the composition of trigger matches necessary
in order for a match to be made.
For more information, see the Threshold
documentation.
Represents the Triggers
that will be checked against
the document and then processed by the Threshold
in
order to determine whether a match is made.
For more information, see the Trigger
documentation.
Represents the id
of the query. This field is optional
but highly recommended, as it will be copied to the
outputs created by this query.
Validates the query, as well as all of its sub-components.
While this is an important mechanism for proper validation
(note that some invalid queries will still compile), one should
always double-check the results by actually compiling the query
and performing a test scan.
Compiles the Query
into a CompiledQuery
. Like all compilation
operations, this is expensive.
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Formats the value using the given formatter. Read more
Serialize this value into the given Serde serializer. Read more
Deserialize this value from the given Serde deserializer. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static