Struct RuleMetadata

#[non_exhaustive]
pub struct RuleMetadata {
    pub rule_id: Option<String>,
    pub rule_name: Option<String>,
    pub short_description: Option<String>,
    pub long_description: Option<String>,
    pub rule_tags: Option<Vec<String>>,
}

Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule_id: Option<String>

The ID of the rule.

rule_name: Option<String>

The name of the rule.

short_description: Option<String>

A short description of the rule.

long_description: Option<String>

A long description of the rule.

rule_tags: Option<Vec<String>>

Tags that are associated with the rule.

Implementations

impl RuleMetadata

pub fn rule_id(&self) -> Option<&str>

The ID of the rule.

pub fn rule_name(&self) -> Option<&str>

The name of the rule.

pub fn short_description(&self) -> Option<&str>

A short description of the rule.

pub fn long_description(&self) -> Option<&str>

A long description of the rule.

pub fn rule_tags(&self) -> &[String]

Tags that are associated with the rule.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rule_tags.is_none().

impl RuleMetadata

pub fn builder() -> RuleMetadataBuilder

Creates a new builder-style object to manufacture RuleMetadata.

Trait Implementations

impl Clone for RuleMetadata

fn clone(&self) -> RuleMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleMetadata

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

Formats the value using the given formatter.

impl PartialEq for RuleMetadata

fn eq(&self, other: &RuleMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RuleMetadata