RuleDoc

Struct RuleDoc 

Source
pub struct RuleDoc {
    pub name: &'static str,
    pub category: &'static str,
    pub description: &'static str,
    pub severity: &'static str,
    pub why: &'static str,
    pub bad_example: &'static str,
    pub good_example: &'static str,
    pub references: &'static [&'static str],
}
Expand description

Documentation for a lint rule (static version for native rules)

Fields§

§name: &'static str

Rule name (e.g., “server-tokens-enabled”)

§category: &'static str

Category (e.g., “security”)

§description: &'static str

Short description

§severity: &'static str

Severity level

§why: &'static str

Why this rule exists

§bad_example: &'static str

Example of bad configuration

§good_example: &'static str

Example of good configuration

§references: &'static [&'static str]

References (URLs, documentation links)

Trait Implementations§

Source§

impl From<&RuleDoc> for RuleDocOwned

Source§

fn from(doc: &RuleDoc) -> Self

Converts to this type from the input type.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.