Struct DoctorReport 

pub struct DoctorReport { /* private fields */ }

Structured doctor report reusable for text and JSON output.

Implementations

impl DoctorReport

pub fn new(header: impl Into<String>) -> Self

Create an empty doctor report.

pub fn for_tool<T: DoctorChecks>(tool: &T) -> Self

Create a doctor report scaffold for a tool using the standard header, version, and checks.

pub fn with_tool_header<T: DoctorChecks>( tool: &T, header: impl Into<String>, ) -> Self

Create a doctor report scaffold for a tool with a caller-provided header.

pub fn with_checks(self, checks: Vec<DoctorCheck>) -> Self

Set the report checks.

pub fn with_version(self, version: impl Into<String>) -> Self

Set the reported version string.

pub fn with_error(self, error: impl Into<String>) -> Self

Add an error line.

pub fn with_warning(self, warning: impl Into<String>) -> Self

Add a warning line.

pub fn with_info(self, info: impl Into<String>) -> Self

Add an informational line.

pub fn with_detail(self, key: impl Into<String>, value: Value) -> Self

Add a custom JSON detail field.

pub fn checks(&self) -> &[DoctorCheck]

Access the underlying checks.

pub fn exit_code(&self) -> i32

Return the process exit code implied by this report.

pub fn to_json_value(&self) -> Value

Render the report as JSON.

pub fn render_text(&self) -> String

Render the report as plain text.

pub fn emit(&self, json: bool) -> i32

Emit the report in the selected format and return its exit code.

Trait Implementations

impl Clone for DoctorReport

fn clone(&self) -> DoctorReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DoctorReport

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

Formats the value using the given formatter.