pub struct RuleDef {
pub id: &'static str,
pub category: &'static str,
pub name: &'static str,
pub short: &'static str,
pub full: &'static str,
pub docs_path: &'static str,
}Expand description
Rule definition for SARIF fullDescription and JSON _meta.
Fields§
§id: &'static strCanonical rule id, such as fallow/unused-export or
security/sql-injection; used as the SARIF rule id.
category: &'static strCoarse category label used by the sticky PR/MR comment renderer to group findings into collapsible sections (Dead code, Dependencies, Duplication, Health, Architecture, Suppressions). One source of truth so the CodeClimate / SARIF / review-envelope path and the renderer never drift; a unit test below asserts every RuleDef has a non-empty category.
name: &'static strHuman-readable rule title.
short: &'static strOne-line description used as the SARIF shortDescription.
full: &'static strParagraph-length description used as the SARIF fullDescription.
docs_path: &'static strPath under the docs site base URL for the rule’s helpUri.
Auto Trait Implementations§
impl Freeze for RuleDef
impl RefUnwindSafe for RuleDef
impl Send for RuleDef
impl Sync for RuleDef
impl Unpin for RuleDef
impl UnsafeUnpin for RuleDef
impl UnwindSafe for RuleDef
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more