Skip to main content

CheckDef

code_ranker_graph::checks

Struct CheckDef

pub struct CheckDef {
    pub when: String,
    pub message: String,
    pub group: Option<String>,
    pub why: Option<String>,
    pub fix: Option<String>,
    pub title: Option<String>,
}

Expand description

One custom check from [rules.checks.<id>].

Fields§

§when: String

CEL boolean predicate over the node’s values. true → a violation.

§message: String

Diagnostic message. {key} placeholders are filled from the node’s values at evaluation time (any attribute, or a derived path field path/name/stem/ext/dir). An unknown {key} is left verbatim.

§group: Option<String>

Concern-group label shown / grouped in diagnostics (free-form, e.g. "TST"). Defaults to [DEFAULT_GROUP].

§why: Option<String>

Optional diagnostic copy — the why / fix lines in check output.

§fix: Option<String>§title: Option<String>

Optional title (SARIF shortDescription). Defaults to the check id.

Trait Implementations§

impl Clone for CheckDef

fn clone(&self) -> CheckDef

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

impl Debug for CheckDef

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CheckDef

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

impl Freeze for CheckDef

impl RefUnwindSafe for CheckDef

impl Send for CheckDef

impl Sync for CheckDef

impl Unpin for CheckDef

impl UnsafeUnpin for CheckDef

impl UnwindSafe for CheckDef

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization

impl<T> AsDebug for T
where T: Debug,

fn as_debug(&self) -> &dyn Debug

Returns self as a &dyn Debug trait object.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

fn coerce_box_to(self: Box<X>) -> Box<T>

fn coerce_ref_to(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.