checkresult

package
v0.41.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Overview

Package checkresult owns immutable owner-classified repository check results.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Evidence

type Evidence struct {
	Kind   string
	Path   string
	Detail string
}

Evidence is the producer-supplied semantic source of a result. Kind and Detail are required; Path is empty when the source has no path.

type Finding

type Finding struct {
	Rank     severity.Rank
	Property Property
	Evidence Evidence
}

Finding is a ranked result whose owner explicitly supplies its fixed rank, protected property, and presentation evidence.

type Information

type Information struct {
	Evidence Evidence
}

Information is an unranked result with producer-supplied presentation evidence. It cannot enter the ranked Finding model.

type Property

type Property string

Property identifies the validity, safety, authority, reproducibility, or other protected property that justifies a ranked finding.

type Result

type Result struct {
	// contains filtered or unexported fields
}

Result is an immutable collection of one check owner's ranked findings and unranked information.

func New

func New(findings []Finding, information []Information) (Result, error)

New constructs a Result after checking the owner-classified values at their boundary. It snapshots both input slices.

func (Result) Findings

func (r Result) Findings() []Finding

Findings returns a defensive projection of this result's ranked findings.

func (Result) Information

func (r Result) Information() []Information

Information returns a defensive projection of this result's unranked information.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL