View Source Guesswork.Answer.Result (Guesswork v0.7.0)

A module for evaluating and displaying query results.

Summary

t()

value()

event_prefix()

Returns the event prefix used by run/2 to create a telemetry span.

Takes a query and attempts to resolve n answers from it.

Takes a value and produces a readable string.

@type t() :: %Guesswork.Answer.Result{
  answer_sets: [%{required(String.t()) => value()}]
}

@type value() ::
  {:bound, Guesswork.Ast.Term.entity()}
  | {:not, [Guesswork.Ast.Term.entity()]}
  | {:constraints, [String.t()]}

@spec event_prefix() :: [atom()]

Returns the event prefix used by run/2 to create a telemetry span.

@spec run(Guesswork.Query.t(), integer()) :: t()

Takes a query and attempts to resolve n answers from it.

@spec value_to_string(value()) :: String.t()

Takes a value and produces a readable string.