Cite.Run (Cite v0.1.0)

One judging run, passed through every step of Cite.judge/4. It starts as what the caller gave, validated once, and each step fills in its part: round 1 fills screen, gathering fills gathered, and round 2 fills findings. Both rounds add their errors, usages, and models. Internal; use Cite.judge/4.

Summary

Types

t()

Functions

new(client, source, policy_module, opts)

A run of source against policy_module. Raises ArgumentError on a client, source, or policy of the wrong kind, or an option it cannot use.

Types

t()

@type t() :: %Cite.Run{
  client: Cite.client(),
  errors: [Cite.Error.t()],
  findings: [Cite.Finding.t()] | nil,
  gathered: [Cite.Gathered.t()] | nil,
  models: [String.t()],
  review_band: {number(), number()},
  screen: Cite.Screen.screen() | nil,
  source: Cite.Source.t(),
  terms: Cite.Policy.Terms.t(),
  threshold: number(),
  usages: [Cite.usage() | nil],
  window: pos_integer()
}

Functions

new(client, source, policy_module, opts)

@spec new(Cite.client(), Cite.Source.t(), module(), keyword()) :: t()

A run of source against policy_module. Raises ArgumentError on a client, source, or policy of the wrong kind, or an option it cannot use.