Enum Source 

pub enum Source {
    NativeDynamic {
        protocol: String,
    },
    KnownSpec {
        provider: String,
    },
    CompletionScript {
        shell: String,
    },
    ManPage {
        format: ManFormat,
    },
    HelpText,
    HelpTextSynopsis,
    UserOverride,
}

The origin of a piece of extracted data. See spec §4.2 and §7.

Variants

NativeDynamic

A native, version-accurate dynamic probe (Tier E): cobra __complete, clap CompleteEnv, argcomplete.

Fields

protocol: String

e.g. "cobra-dunder-complete", "clap-complete-env".

String rather than &'static str: a Source must round-trip through the on-disk cache (spec §11), and a borrowed 'static string cannot in general be produced by Deserialize without leaking memory.

KnownSpec

A vendored or live structured catalog (Tier A).

Fields

provider: String

e.g. "carapace", "withfig".

CompletionScript

Structural parsing of a generated shell completion script (Tier C).

Fields

shell: String

e.g. "zsh", "bash".

ManPage

Man page extraction (Tier D).

Fields

format: ManFormat

Whether the page used semantic mdoc(7) macros or plain man(7).

HelpText

--help/-h/help grammar parsing (Tier B) of a structured block (an options table, .TP-shaped entry, or similar) that carries prose alongside each flag.

HelpTextSynopsis

--help/-h/help grammar parsing (Tier B) of a usage synopsis line specifically (spec [M-15]): git --help’s [-p | --paginate | -P | --no-pager], mined by help_text::sections::extract_usage_flags. A separate variant rather than a field on HelpText, because a synopsis is genuinely a different extraction site — the same reason ManPage carries format and CompletionScript carries shell instead of HelpText growing a field each of them would also need.

A usage synopsis lists spellings and value shapes only, never prose, by construction — spec §7 Tier B forbids fabricating a description for one from neighbouring text. A flag whose only source is this variant is therefore structurally undescribable, not merely undescribed: Source::can_describe says so, and spec §13’s pct_flags_with_text excludes it from the denominator rather than punishing recall for having found it (the defect [M-15] and this redefinition both exist to fix — see spec §13’s metric design rules).

UserOverride

A user-local override file (Tier F).

Implementations

impl Source

pub fn authority(&self) -> Authority

This source’s two-axis Authority, per spec §4.4’s table.

pub fn can_describe(&self) -> bool

Whether this source could, in principle, have supplied a description — spec §13’s metric design rules (rule 2: “denominators are conditioned on what the source could have provided”). false only for Source::HelpTextSynopsis: a usage synopsis lists spellings and value shapes, never prose, by construction. Every other source at least could have carried a description, whether or not it did for a given flag.

pub fn label(&self) -> String

A short, human-readable label for UI footers, e.g. "carapace", "help-text".

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Source

impl PartialEq for Source

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Source

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 Source