Struct CheckResult 

pub struct CheckResult {
    pub plugin: String,
    pub check: String,
    pub severity: Severity,
    pub message: String,
    pub details: Option<String>,
}

Check result struct Each cradle check should return this struct after execution

Fields

plugin: String

Calling plugin name

check: String

Check name

severity: Severity

Result severity (see: Severity)

message: String

Message included in the check’s result

details: Option<String>

Optional details for the message

Implementations

impl CheckResult

pub fn pass( plugin: &str, check: &str, message: impl Into<String>, ) -> CheckResult

Small helper to create a pass result (Severity::Pass)

pub fn info( plugin: &str, check: &str, message: impl Into<String>, ) -> CheckResult

Small helper to create an informational result (Severity::Info)

pub fn warn( plugin: &str, check: &str, message: impl Into<String>, ) -> CheckResult

Small helper to create a warning result (Severity::Warn)

pub fn fail( plugin: &str, check: &str, message: impl Into<String>, ) -> CheckResult

Small helper to create a failure result (Severity::Fail)

pub fn critical( plugin: &str, check: &str, message: impl Into<String>, ) -> CheckResult

Small helper to create a critical error result (Severity::Critical)

pub fn with_details(self, details: impl Into<String>) -> CheckResult

Adds details to the given check result

Trait Implementations

impl Clone for CheckResult

fn clone(&self) -> CheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CheckResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.