Struct Report 

pub struct Report {
    pub check: String,
    pub outcome: Outcome,
    pub skipped: Option<SkipReason>,
    pub status: Option<i32>,
    pub details: Option<Details>,
    pub attachments: Vec<Attachment>,
}

The result of one check run.

Fields

check: String

The check name.

outcome: Outcome

How the check ended.

skipped: Option<SkipReason>

Why the check did not run.

status: Option<i32>

The exit status of the command, when it ran.

details: Option<Details>

The structured result, when a converter produced one.

attachments: Vec<Attachment>

Files stored next to the report.

Implementations

impl Report

pub fn plain(check: &str, outcome: Outcome, status: Option<i32>) -> Self

A report with an outcome and an exit status and nothing else.

pub fn skipped(check: &str, reason: SkipReason) -> Self

A report for a check that did not run.

pub fn passed(&self) -> bool

Whether the check did not fail. A skipped check passes.

pub fn attach( &mut self, directory: &Path, name: &str, file: &str, contents: &[u8], ) -> Result<(), ReportError>

Store contents as file in directory and list it as an attachment.

The directory is created when it is missing.

Errors

Returns an error when the directory or the file cannot be written.

pub fn write(&self, directory: &Path) -> Result<(), ReportError>

Write report.json into directory and create the directory first.

Errors

Returns an error when the directory or the file cannot be written.

pub fn read(directory: &Path) -> Result<Self, ReportError>

Read report.json from directory.

Errors

Returns an error when the file is missing or is not a valid report.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Eq for Report

impl<'ʄ> Facet<'ʄ> for Report

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for Report

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Report