Struct RecommendationSummary

#[non_exhaustive]
pub struct RecommendationSummary {
    pub file_path: Option<String>,
    pub recommendation_id: Option<String>,
    pub start_line: Option<i32>,
    pub end_line: Option<i32>,
    pub description: Option<String>,
    pub recommendation_category: Option<RecommendationCategory>,
    pub rule_metadata: Option<RuleMetadata>,
    pub severity: Option<Severity>,
}

Information about recommendations.

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.

file_path: Option<String>

Name of the file on which a recommendation is provided.

recommendation_id: Option<String>

The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

start_line: Option<i32>

Start line from where the recommendation is applicable in the source commit or source branch.

end_line: Option<i32>

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

description: Option<String>

A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

recommendation_category: Option<RecommendationCategory>

The type of a recommendation.

rule_metadata: Option<RuleMetadata>

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.

severity: Option<Severity>

The severity of the issue in the code that generated this recommendation.

Implementations

impl RecommendationSummary

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

Name of the file on which a recommendation is provided.

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

The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

pub fn start_line(&self) -> Option<i32>

Start line from where the recommendation is applicable in the source commit or source branch.

pub fn end_line(&self) -> Option<i32>

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

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

A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

pub fn recommendation_category(&self) -> Option<&RecommendationCategory>

The type of a recommendation.

pub fn rule_metadata(&self) -> Option<&RuleMetadata>

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.

pub fn severity(&self) -> Option<&Severity>

The severity of the issue in the code that generated this recommendation.

impl RecommendationSummary

pub fn builder() -> RecommendationSummaryBuilder

Creates a new builder-style object to manufacture RecommendationSummary.

Trait Implementations

impl Clone for RecommendationSummary

fn clone(&self) -> RecommendationSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecommendationSummary

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

Formats the value using the given formatter.

impl PartialEq for RecommendationSummary

fn eq(&self, other: &RecommendationSummary) -> 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 RecommendationSummary