Output
represents a 'match' of a Query. It is the primary
product of an IEQL scan, and contains many variable (and configurable)
pieces of data and metadata.
Note: response
and output
are synonymous in the context of this
documentation.
Outputs have two kinds: Full
and Partial
. Full outputs are for
matches which exist on their own—for example, a match of someone's
name online. Partial outputs, however, are meant to be MapReduced.
For example, if a linguist wanted to count the number of times a certain
word appears online, they would configure their query to produce a Partial
response, which they would then MapReduce.
There is not currently full support for partial IEQL outputs.
Contains the data relevant for the user; for example, excerpts of the match.
Represents the kind of the output (Full
or Partial
).
This is an optional value for identifying the output, and can vary
based on your implementation. In most cases, when present, this
is some form of UUID.
This is the ID of the query that created the output. Note that this
will only be present when the query that created the output itself
has an id.
Create a new output from the given data. Please note that this
operation is expensive!
document
: the compiled document that the query matched
query
: the compiled query that matched the document
matches
: the PatternMatch
es produced by the queries' triggers
id
: the optional ID of the desired output
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
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
Converts the given value to a String
. 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
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
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
)