Struct ieql::input::document::CompiledDocument

pub struct CompiledDocument {
    pub url: Option<String>,
    pub raw: String,
    pub mime: Option<String>,
    pub text: String,
    pub domain: Option<String>,
}

A CompiledDocument is a Document that has been processed and is ready to be scanned. During compilation, the IEQL document compiler extracts the following information from the Document:

• text — the text of the document. Currently, only HTML parsing is supported.
• domain — the domain name, if present, is also processed.
• raw — unlike Documents, whose contents are bytes, CompiledDocuments have text.

In cases that the document is not HTML, text is identical to raw.

Fields

url: Option<String>

raw: String

mime: Option<String>

text: String

domain: Option<String>

Methods

impl CompiledDocument

pub fn content(&self, content: ScopeContent) -> &String

This function returns the document content relative to the given ScopeContent. For example, if the ScopeContent is Raw, this function will return the document's Raw data. If it is Text, this function will return the document's parsed text.

Trait Implementations

impl CompilableTo<CompiledDocument> for Document

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

Returns a compiled version of self, without using self. Importantly, compiling a component will perform a deep clone on that component. Remember: compilation is expensive!