Struct ieql::input::document::Document

pub struct Document {
    pub url: Option<String>,
    pub data: Vec<u8>,
    pub mime: Option<String>,
}

The Document struct represents any kind of document, but typically some sort of Internet document. A Document can often be quite large; after all, it contains the entire text of a document.

In practice, this struct functions more as an interim format as data becomes a CompiledDocument.

Fields

url: Option<String>

url represents the URL of the document, if it is present.

For internet documents, this typically takes the form of Some("https://..."), whereas for local documents this typically takes the form of Some("/path/to/file").

data: Vec<u8>

data contains the data of the document.

This data is stored as a Vec<u8> primarily for first-class text document support (utf8).

mime: Option<String>

mime represents a valid IETF mime type, as per RFC 2045.

Methods

impl Document

pub fn domain(&self) -> Option<String>

This function extracts the hostname (domain name) of a document. In cases where the host name isn't known, this function returns None.

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!