Skip to main content

Report

Struct Report 

Source
pub struct Report {
    pub case_name: String,
    pub severity: Severity,
    pub primary: Option<Diagnosis>,
    pub also_considered: Vec<Diagnosis>,
    pub reproduction: String,
}
Expand description

Top-level result of crate::rules::diagnose.

primary is None when no rule fired with confidence ≥ 0.6 (the classification threshold). also_considered is sorted by descending confidence and capped above by the primary’s confidence.

Fields§

§case_name: String

Stable name of the case being diagnosed (matches Case::name).

§severity: Severity

Severity tag from the case (mirrored verbatim).

§primary: Option<Diagnosis>

Top-confidence diagnosis, if any rule fired above threshold.

§also_considered: Vec<Diagnosis>

Other rules that fired, sorted by descending confidence and bounded above by primary.confidence. Empty when only one rule fired (or none did).

§reproduction: String

Pre-rendered curl reproduction string. Header order is alphabetical; the body is inlined with --data-raw so the string is the same on every machine (no absolute paths).

Implementations§

Source§

impl Report

Source

pub fn exit_code(&self) -> i32

Process exit code the CLI should return for this report.

0 if a primary diagnosis fired with confidence ≥ 0.60, 1 if the case is unclassified or low-confidence. The threshold matches the human formatter’s “No rule matched” message. Higher-level “bad input” errors are mapped to exit code 2 by the CLI itself, not here.

§Examples
use api_debug_lab::{diagnose, Case};
use std::path::Path;

let case = Case::load("auth_missing", Path::new("fixtures"))?;
assert_eq!(diagnose(&case).exit_code(), 0);
Source

pub fn render(&self, format: Format) -> String

Render the report in the requested Format.

Both formats are byte-stable: the same input always produces the same output bytes. The JSON format uses pretty-printing so diffs in PRs are legible.

§Examples
use api_debug_lab::{diagnose, Case, Format};
use std::path::Path;

let case = Case::load("auth_missing", Path::new("fixtures"))?;
let report = diagnose(&case);
let human = report.render(Format::Human);
assert!(human.starts_with("CASE:"));

Trait Implementations§

Source§

impl Clone for Report

Source§

fn clone(&self) -> Report

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Report

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Report

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Report

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Report

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Report

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,