Struct Provenance 

pub struct Provenance {
    pub sources: SmallVec<[Source; 2]>,
    pub confidence: Option<f32>,
}

Which extraction source(s) contributed to an item, in contribution order, plus a confidence score set only by heuristic tiers.

Fields

sources: SmallVec<[Source; 2]>

Contributing sources, ordered by contribution (earliest first).

confidence: Option<f32>

Set only when a heuristic tier (e.g. Tier B help-text) produced this item; None for structured/authoritative sources.

Implementations

impl Provenance

pub fn single(source: Source) -> Provenance

A Provenance crediting a single source, with no confidence score.

pub fn with_confidence(source: Source, confidence: f32) -> Provenance

A Provenance crediting a single heuristic source with a confidence score.

pub fn effective_authority(&self, axis: Axis) -> u8

The highest authority on axis among this item’s contributing sources. 0 if there are no contributing sources.

pub fn describable(&self) -> bool

Whether an item carrying this provenance could, in principle, have been described — spec §13’s metric design rules. true when any contributing source Source::can_describe (a flag merged from several tiers is describable if even one of them could have supplied prose, e.g. a synopsis spelling later reconciled against a structured entry — see help_text::sections::flag_spelling_already_present). true also when there are no contributing sources at all: an empty Provenance is not this codebase’s way of saying “usage-synopsis only,” so it must not silently disappear from a describability count the way a real HelpTextSynopsis-only item correctly does.

pub fn absorb(&mut self, other: &Provenance)

Merge another Provenance into this one: union the source lists (deduplicated, order preserved) and combine confidence conservatively (the lower of the two, since overall trust is bounded by the least-confident contributor).

Trait Implementations

impl Clone for Provenance

fn clone(&self) -> Provenance

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Provenance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Provenance

fn default() -> Provenance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Provenance

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Provenance> for ProvenanceSnapshot

fn from(p: &Provenance) -> Self

Converts to this type from the input type.

impl PartialEq for Provenance

fn eq(&self, other: &Provenance) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Provenance

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Provenance