Skip to main content

CheckResult

Struct CheckResult 

Source
pub struct CheckResult {
    pub check_id: String,
    pub check_name: String,
    pub severity: Severity,
    pub message: String,
    pub suggestion: Option<String>,
    pub location: Option<(String, Option<usize>)>,
}

Fields§

§check_id: String

Machine-readable check id, e.g. discovery.description_length. Surfaced by the machine-readable report format consumed by tests; not yet read by the human renderer.

§check_name: String

Human label, e.g. SKILL.md description is under 1,536 characters.

§severity: Severity§message: String

Short status line. For failures this is the what’s wrong.

§suggestion: Option<String>

The actionable fix, per design §8.1 “Errors teach, not just complain”. Populated on Warn/Error; the one-liner suggestion.

§location: Option<(String, Option<usize>)>

File + line where the problem lives, when we can pin it down. Line is 1-based, None if file-level only.

Implementations§

Source§

impl CheckResult

Source

pub fn pass( check_id: &str, check_name: &str, message: impl Into<String>, ) -> Self

A clean pass with no suggestion needed.

Source

pub fn warn( check_id: &str, check_name: &str, message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Source

pub fn fail( check_id: &str, check_name: &str, message: impl Into<String>, suggestion: impl Into<String>, ) -> Self

Source

pub fn skipped( check_id: &str, check_name: &str, message: impl Into<String>, ) -> Self

Source

pub fn is_critical_failure(&self) -> bool

True if this result fails verify (critical severity).

Trait Implementations§

Source§

impl Clone for CheckResult

Source§

fn clone(&self) -> CheckResult

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 CheckResult

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more