Hui v0.11.0

View Source Hui.Query.HighlighterOriginal (Hui v0.11.0)

Struct related to results highlighting - Original highlighter

Link to this section Summary

Types

t()

Struct for original highlighter, use in conjunction with the highlighting struct -Hui.Query.Highlight.t/0.

Functions

new()
new(field, len \\ nil, highlight \\ nil)

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Hui.Query.HighlighterOriginal{
  alternateField: binary(),
  formatter: :simple,
  fragmenter: :gap | :regex,
  highlightAlternate: boolean(),
  maxAlternateFieldLength: number(),
  maxMultiValuedToExamine: number(),
  maxMultiValuedToMatch: number(),
  mergeContiguous: boolean(),
  payloads: boolean(),
  per_field: boolean(),
  per_field_method: :fastVector,
  preserveMulti: boolean(),
  "regex.maxAnalyzedChars": number(),
  "regex.pattern": binary(),
  "regex.slop": number(),
  "simple.post": binary(),
  "simple.pre": binary()
}

Struct for original highlighter, use in conjunction with the highlighting struct -Hui.Query.Highlight.t/0.

Link to this section Functions

Link to this function

new()

View Source 
@spec new() :: t()
Link to this function

new(field, len \\ nil, highlight \\ nil)

View Source 
@spec new(binary(), integer(), boolean()) :: t()