Hui v0.11.0

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

Struct related to results highlighting - Unified Highlighter.

Link to this section Summary

Types

t()

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

Functions

new()
new(d, s \\ nil)

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Hui.Query.HighlighterUnified{
  "bs.country": binary(),
  "bs.language": binary(),
  "bs.separator": binary(),
  "bs.type": :SEPARATOR | :SENTENCE | :WORD | :CHARACTER | :LINE | :WHOLE,
  "bs.variant": binary(),
  defaultSummary: boolean(),
  offsetSource:
    :ANALYSIS | :POSTINGS | :POSTINGS_WITH_TERM_VECTORS | :TERM_VECTORS,
  per_field: false,
  "score.b": number(),
  "score.k1": number(),
  "score.pivot": number(),
  "tag.ellipsis": binary(),
  weightMatches: boolean()
}

Struct for unified 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(d, s \\ nil)

View Source 
@spec new(atom(), boolean()) :: t()