analysis

Documentation

Overview

Copyright 2025 National Technology and Engineering Solutions of Sandia SPDX-License-Identifier: BSD-3-Clause

Index

• Constants
• type Config
• type Entry
  • func (e Entry) Terminal() bool
• type Snapshot
  • func Run(ctx context.Context, cfg Config) (Snapshot, error)
• type Stage
• type Status
• type Summary

Constants

const DefaultWorkers = 4

Types

type Config

type Config struct {
	EntryIDs  []int
	Workers   int
	Extract   func(int) (string, error)
	Lookup    func(string) (*lookup.Result, error)
	Summarize func(*lookup.Result) (Summary, error)
	Progress  func(Snapshot)
}

type Entry

type Entry struct {
	ID int

	ExtractionStatus Status
	Text             string
	ExtractionError  error

	LookupStatus Status
	Result       *lookup.Result
	LookupError  error

	SummaryStatus Status
	Summary       Summary
	SummaryError  error
}

func (Entry) Terminal

func (e Entry) Terminal() bool

type Snapshot

type Snapshot struct {
	Entries   []Entry
	Completed int
	Done      bool
}

func Run

func Run(ctx context.Context, cfg Config) (Snapshot, error)

type Stage

type Stage string

const (
	StageExtraction Stage = "extraction"
	StageLookup     Stage = "lookup"
	StageSummary    Stage = "summary"
)

type Status

type Status string

const (
	StatusWaiting   Status = "waiting"
	StatusPending   Status = "pending"
	StatusActive    Status = "active"
	StatusCompleted Status = "completed"
	StatusError     Status = "error"
)

type Summary

type Summary struct {
	Mismatch bool
	Comment  string
}