Struct ieql::output::output::Output

pub struct Output {
    pub items: Vec<OutputItem>,
    pub kind: OutputKind,
    pub id: Option<String>,
    pub query_id: Option<String>,
}

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.

Fields

items: Vec<OutputItem>

Contains the data relevant for the user; for example, excerpts of the match.

kind: OutputKind

Represents the kind of the output (Full or Partial).

id: Option<String>

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.

query_id: Option<String>

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.

Methods

impl Output

pub fn new(
    document: &CompiledDocument,
    query: &CompiledQuery,
    matches: Vec<PatternMatch>,
    id: Option<String>
) -> Output

Create a new output from the given data. Please note that this operation is expensive!

Arguments

• document: the compiled document that the query matched
• query: the compiled query that matched the document
• matches: the PatternMatches produced by the queries' triggers
• id: the optional ID of the desired output

Trait Implementations

impl Debug for Output

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Output

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Output

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq<Output> for Output

fn eq(&self, other: &Output) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Output) -> bool

This method tests for !=.

impl Serialize for Output

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Output