Struct FailureDiagnostic 

pub struct FailureDiagnostic {
    pub title: String,
    pub source: DiagnosticSource,
    pub confidence: DiagnosticConfidence,
    pub reason: String,
    pub cause: FailureCause,
    pub fallback: Option<String>,
    pub tried: Vec<String>,
    pub actions: Vec<DiagnosticAction>,
    pub commands: Vec<String>,
    pub records: Vec<DiagnosticRecord>,
}

Actionable diagnostic document for failed or low-confidence pages.

Fields

title: String

Diagnostic title.

source: DiagnosticSource

Boundary that produced the diagnostic.

confidence: DiagnosticConfidence

Confidence level.

reason: String

Short user-facing reason.

cause: FailureCause

Likely cause classification.

fallback: Option<String>

Fallback that was attempted or selected.

tried: Vec<String>

Steps or boundaries Index tried before failing.

actions: Vec<DiagnosticAction>

Suggested next actions.

commands: Vec<String>

Exact suggested commands.

records: Vec<DiagnosticRecord>

Structured diagnostic records.

Implementations

impl FailureDiagnostic

pub fn new( title: impl Into<String>, source: DiagnosticSource, confidence: DiagnosticConfidence, reason: impl Into<String>, ) -> Self

Creates an actionable diagnostic.

pub fn with_likely_cause(self, cause: FailureCause) -> Self

Overrides the likely cause classification.

pub fn with_fallback(self, fallback: impl Into<String>) -> Self

Adds fallback information.

pub fn with_tried(self, tried: impl Into<String>) -> Self

Adds a deterministic “what Index tried” entry.

pub fn with_actions( self, actions: impl IntoIterator<Item = DiagnosticAction>, ) -> Self

Adds suggested next actions.

pub fn with_command(self, command: impl Into<String>) -> Self

Adds one exact suggested command.

pub fn with_record(self, record: DiagnosticRecord) -> Self

Adds one structured diagnostic record.

pub fn redacted(&self, redactor: &Redactor) -> Self

Returns a redacted copy suitable for logs and fixture submissions.

pub fn to_local_text(&self) -> String

Formats deterministic local diagnostic text.

pub fn suggested_commands(&self) -> Vec<String>

Returns exact suggested commands.

pub fn into_document(self) -> IndexDocument

Converts the diagnostic into an Index document.

Trait Implementations

impl Clone for FailureDiagnostic

fn clone(&self) -> FailureDiagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FailureDiagnostic

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

Formats the value using the given formatter.

impl PartialEq for FailureDiagnostic

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FailureDiagnostic

impl StructuralPartialEq for FailureDiagnostic