Hui v0.11.0

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

Struct related to the common parameters of results highlighting.

See :

Link to this section Summary

Types

t()

Struct for results highlighting

Functions

new()
new(fl, snippets \\ nil, fragsize \\ nil)

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Hui.Query.Highlight{
  encoder: binary(),
  field: binary(),
  fl: binary(),
  fragsize: number(),
  highlightMultiTerm: boolean(),
  hl: boolean(),
  maxAnalyzedChars: number(),
  method: :unified | :original | :fastVector,
  per_field: boolean(),
  q: binary(),
  qparser: binary(),
  requireFieldMatch: boolean(),
  snippets: number(),
  "tag.post": binary(),
  "tag.pre": binary(),
  usePhraseHighlighter: boolean()
}

Struct for results highlighting

Link to this section Functions

Link to this function

new()

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

new(fl, snippets \\ nil, fragsize \\ nil)

View Source 
@spec new(binary(), number(), number()) :: t()